Toma de notas con Markdown y GitHub

Cómo creé un repositorio simple para tomar notas usando Markdown y GitHub.

Lo entiendo, estás harto de los miles de videos de YouTube y publicaciones de blog sobre cómo tomar notas. ¡Yo también! Así que decidí ir al grano y construir mi propio sistema de toma de notas, lo más simple posible, sin BS.

¿Noción ? Sí, se ve increíble, pero no tengo tiempo para subir esa empinada curva de aprendizaje.

¿Básicamente alguna aplicación móvil para tomar notas? Podría ser, pero quiero poder buscar rápidamente información mientras trabajo, minimizar el cambio de contexto y, con suerte, mantener mis manos sobre el teclado mientras lo hago.

¿Un archivo de texto plano? Tal vez un poco demasiado extremo, sí, es simple y no requiere mantenimiento, pero quiero que mis notas sean legibles y, por otro lado, no quiero perder el tiempo formateando lo que escribo... entonces, ¿quién puede salvarme ahora?

Introduzca Markdown . Fácil de escribir, lleva muy poco tiempo acostumbrarse a la sintaxis y el resultado final es más que aceptable.

Ahora imagine esta situación: está navegando a través de una gran base de código en el editor de texto de su elección, y se encuentra con una función o el uso de un método, y desea revisar su implementación. Lo que normalmente hago en este caso es iniciar una búsqueda en todo el proyecto en VS Code y obtengo resultados instantáneos. Entonces, ¿por qué no reunimos lo mejor de ambos mundos?

Markdown y VS Code juntos brindan soluciones para mis dos problemas más grandes con cualquier sistema de toma de notas: escribir fácilmente notas legibles con un esfuerzo mínimo de formato y la capacidad de consultar información cuando lo desee .

Entonces, ¿cómo lo construyes? Es tan fácil como crear un repositorio vacío en GitHub y luego iniciar Visual Studio Code para la Web .

Una vez que esté allí, haga clic en "Abrir carpeta", y VS Code dirá que no se admite la apertura de carpetas locales y, en cambio, le permitirá abrir una carpeta remota. Al iniciar sesión con su cuenta de GitHub, podrá abrir cualquier repositorio que desee.

Me gusta estructurar mis notas de la siguiente manera:

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

Dentro de cada carpeta de proyecto, Useful Commands aloja un único archivo de descuento con comandos útiles para tareas como iniciar contenedores Docker, ejecutar pruebas, etc.

La investigación contiene notas de investigación para diferentes temas, el objetivo principal aquí es tratar de explicarme los conceptos como si se los estuviera explicando a otra persona.

Tareas es la que creo que ha tenido el mayor impacto en mi productividad. Aquí coloco un archivo Markdown para cada ticket de Jira que me asignan, y trato de seguir esta plantilla:

# 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.

Eso es todo por este, si llegaste al final de esta publicación, ¡muchas gracias y que tengas un buen día! :)