Notizen machen mit Markdown und GitHub

Wie ich mit Markdown und GitHub ein einfaches Repository zum Notieren erstellt habe.

Ich verstehe, Sie haben die Tausenden von YouTube-Videos und Blogbeiträgen zum Thema Notizen satt. Ich auch! Also beschloss ich, es auf den Punkt zu bringen und mein ganz eigenes, möglichst einfaches, unkompliziertes Notizsystem zu bauen.

Vorstellung ? Ja, sieht toll aus, aber ich habe keine Zeit, diese steile Lernkurve zu erklimmen.

Im Grunde eine mobile App zum Notieren? Könnte sein, aber ich möchte in der Lage sein, während der Arbeit schnell nach Informationen zu suchen, den Kontextwechsel zu minimieren und dabei hoffentlich die Hände über der Tastatur zu lassen.

Eine reine Textdatei? Vielleicht etwas zu extrem, ja, es ist einfach und erfordert keinerlei Wartung, aber ich möchte, dass meine Notizen lesbar sind, und andererseits möchte ich keine Zeit damit verschwenden, das, was ich schreibe, zu formatieren ... also, wer kann mich jetzt retten?

Geben Sie Markdown ein . Einfach zu schreiben, man muss sich nur sehr schnell an die Syntax gewöhnen und das Endergebnis ist mehr als akzeptabel!

Stellen Sie sich nun folgende Situation vor: Sie durchsuchen eine große Codebasis in einem Texteditor Ihrer Wahl, stoßen auf die Verwendung einer Funktion oder Methode und möchten deren Implementierung noch einmal überprüfen. Normalerweise starte ich in diesem Fall eine projektweite Suche nach VS Code und erhalte sofort Ergebnisse. Warum also nicht das Beste aus beiden Welten vereinen?

Markdown und VS Code bieten zusammen Lösungen für meine beiden größten Probleme mit jedem Notizsystem: einfaches Schreiben lesbarer Notizen mit minimalem Formatierungsaufwand und die Möglichkeit, Informationen jederzeit abzufragen .

Also, wie baut man es auf? Es ist so einfach wie das Erstellen eines leeren Repositorys in GitHub und das anschließende Starten von Visual Studio Code for the Web .

Sobald Sie dort sind, klicken Sie auf „Ordner öffnen“ und VS Code wird Ihnen mitteilen, dass das Öffnen lokaler Ordner nicht unterstützt wird und Sie stattdessen einen Remote-Ordner öffnen können. Wenn Sie sich mit Ihrem GitHub-Konto anmelden, können Sie jedes gewünschte Repository öffnen.

Ich strukturiere meine Notizen gerne folgendermaßen:

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

In jedem Projektordner hostet Useful Commands eine einzelne Markdown-Datei mit nützlichen Befehlen für Aufgaben wie das Starten von Docker-Containern, das Ausführen von Tests usw.

Die Forschung enthält Forschungsnotizen zu verschiedenen Themen. Das Hauptziel hier ist es, mir selbst Konzepte so zu erklären, als würde ich sie jemand anderem erklären.

Aufgaben haben meiner Meinung nach den größten Einfluss auf meine Produktivität. Hier platziere ich eine Markdown-Datei für jedes Jira-Ticket, das mir zugewiesen wird, und versuche, dieser Vorlage zu folgen:

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

Das war’s für diesen Beitrag. Wenn Sie es bis zum Ende dieses Beitrags geschafft haben, vielen Dank und einen schönen Tag! :) :)