Prise de notes avec Markdown et GitHub

Comment j'ai créé un référentiel simple pour prendre des notes à l'aide de Markdown et GitHub.

Je comprends, vous en avez assez des milliers de vidéos YouTube et d'articles de blog sur la prise de notes. Donc je suis! J'ai donc décidé d'aller droit au but et de créer mon propre système de prise de notes, aussi simple que possible, sans BS.

Notion ? Ouais, ça a l'air incroyable mais je n'ai pas le temps de gravir cette courbe d'apprentissage abrupte.

Fondamentalement, une application mobile pour prendre des notes ? Peut-être, mais je veux pouvoir rechercher rapidement des informations pendant que je travaille, minimiser les changements de contexte et, espérons-le, garder mes mains sur mon clavier pendant que j'y suis.

Un fichier texte brut ? Peut-être un peu trop extrême, ouais c'est simple et ne demande aucune maintenance, mais je veux que mes notes soient lisibles, et d'autre part je ne veux pas perdre de temps à formater ce que j'écris… alors, qui peut me sauver maintenant ?

Entrez Markdown . Facile à écrire, prend très peu de temps pour s'habituer à la syntaxe, et le résultat final est plus qu'acceptable !

Imaginez maintenant cette situation : vous parcourez une grande base de code dans l'éditeur de texte de votre choix, et vous rencontrez l'utilisation d'une fonction ou d'une méthode, et vous souhaitez revoir son implémentation. Ce que je fais normalement dans ce cas, c'est lancer une recherche à l'échelle du projet sur VS Code, et j'obtiens des résultats instantanés. Alors pourquoi ne pas réunir le meilleur des deux mondes ?

Markdown et VS Code fournissent ensemble des solutions à mes deux plus gros problèmes avec n'importe quel système de prise de notes : écrire facilement des notes lisibles avec un minimum d'efforts de formatage et la possibilité d'interroger des informations quand je le souhaite .

Alors, comment le construisez-vous? C'est aussi simple que de créer un référentiel vide dans GitHub, puis de lancer Visual Studio Code for the Web .

Une fois que vous y êtes, cliquez sur "Ouvrir le dossier", et VS Code dira que l'ouverture de dossiers locaux n'est pas prise en charge et vous laissera plutôt ouvrir un dossier distant. En vous connectant avec votre compte GitHub, vous pourrez ouvrir n'importe quel référentiel que vous souhaitez.

J'aime structurer mes notes de la manière suivante :

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

Dans chaque dossier de projet, Useful Commands héberge un seul fichier Markdown avec des commandes utiles pour des tâches telles que le démarrage de conteneurs Docker, l'exécution de tests, etc.

La recherche contient des notes de recherche sur différents sujets, l'objectif principal ici est d'essayer de m'expliquer des concepts comme si je les expliquais à quelqu'un d'autre.

Les tâches sont celles qui, selon moi, ont eu le plus grand impact sur ma productivité. Ici, je place un fichier Markdown pour chaque ticket Jira qui m'est attribué, et j'essaie de suivre ce modèle :

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

C'est tout pour celui-ci, si vous l'avez fait au bas de ce post merci beaucoup et bonne journée! :)