Anotações com Markdown e GitHub

Como fiz um repositório simples para fazer anotações usando Markdown e GitHub.

Eu entendo, você está cansado dos milhares de vídeos do YouTube e postagens de blog sobre como fazer anotações. Eu também sou! Então, decidi ir direto ao ponto e construir meu próprio sistema de anotações, o mais simples possível e sem BS.

Noção ? Sim, parece incrível, mas não tenho tempo para escalar essa curva de aprendizado íngreme.

Basicamente, qualquer aplicativo móvel para fazer anotações? Pode ser, mas quero ser capaz de pesquisar informações rapidamente enquanto estou trabalhando, minimizar a troca de contexto e, com sorte, manter minhas mãos sobre o teclado enquanto faço isso.

Um arquivo de texto simples? Talvez um pouco extremo demais, sim, é simples e não requer manutenção, mas quero que minhas anotações sejam legíveis e, por outro lado, não quero perder tempo formatando o que escrevo ... então, quem pode me salvar agora?

Digite Markdown . Fácil de escrever, leva muito pouco tempo para se acostumar com a sintaxe e o resultado final é mais do que aceitável!

Agora imagine esta situação: você está navegando por uma grande base de código no editor de texto de sua escolha e se depara com o uso de uma função ou método e deseja revisitar sua implementação. O que normalmente faço nesse caso é iniciar uma pesquisa em todo o projeto no VS Code e obtenho resultados instantâneos. Então, por que não reunimos o melhor dos dois mundos?

Juntos, o Markdown e o VS Code fornecem soluções para meus dois maiores problemas com qualquer sistema de anotações: escrever notas facilmente legíveis com esforços mínimos de formatação e a capacidade de consultar informações sempre que eu quiser .

Então, como você o constrói? É tão fácil quanto criar um repositório vazio no GitHub e acionar o Visual Studio Code para a Web .

Quando estiver lá, clique em “Abrir pasta” e o VS Code dirá que a abertura de pastas locais não é suportada e, em vez disso, permitirá que você abra uma pasta remota. Ao fazer login com sua conta do GitHub, você poderá abrir qualquer repositório que desejar.

Eu gosto de estruturar minhas notas da seguinte maneira:

- <Project Name>
  - Useful Commands
  - Research
  - Tasks

Dentro de cada pasta do projeto, o Useful Commands hospeda um único arquivo markdown com comandos úteis para tarefas como iniciar contêineres do Docker, executar testes e assim por diante.

A pesquisa contém notas de pesquisa para diferentes tópicos, o objetivo principal aqui é tentar explicar os conceitos para mim mesmo como se estivesse explicando para outra pessoa.

Tarefas é o que eu acredito ter causado o maior impacto na minha produtividade. Aqui, coloco um arquivo Markdown para cada tíquete do Jira que recebo e tento seguir este modelo:

# JIRA_ID - Ticket name
Short description of the task. 
If the task doesn't have an acceptance criteria it is a good exercise 
to read the description a few times and write it down yourself.

In here I leave a space for pasting useful material, like code snippets,
links, YouTube videos, anything that might help me answer whatever
questions arise.

## Steps To Succeed
Step by step definition, with clear action items to achieve a solution.
Include possible alternate paths, and every thought that helps you implement
your idea.

É isso, se você chegou ao final deste post, muito obrigado e tenha um bom dia! :)