Sporządzanie notatek w Markdown i GitHub

Jak stworzyłem proste repozytorium do robienia notatek przy użyciu Markdown i GitHub.

Rozumiem, że masz dość tysięcy filmów na YouTube i postów na blogach dotyczących robienia notatek. Ja też! Postanowiłem więc przejść do sedna i zbudować własny, tak prosty, jak to tylko możliwe, system robienia notatek bez BS.

pojęcie ? Tak, wygląda niesamowicie, ale nie mam czasu na wspinanie się po tej stromej krzywej uczenia się.

Zasadniczo jakaś aplikacja mobilna do robienia notatek? Możliwe, ale chcę mieć możliwość szybkiego wyszukiwania informacji podczas pracy, zminimalizowania przełączania kontekstu i miejmy nadzieję, że podczas pracy trzymam ręce nad klawiaturą.

Zwykły plik tekstowy? Może trochę zbyt ekstremalne, tak, jest proste i nie wymaga żadnej konserwacji, ale chcę, aby moje notatki były czytelne, az drugiej strony nie chcę tracić czasu na formatowanie tego, co piszę… więc kto może mnie teraz uratować?

Wpisz Markdown . Łatwy do napisania, przyzwyczajenie się do składni zajmuje bardzo mało czasu, a efekt końcowy jest więcej niż akceptowalny!

A teraz wyobraź sobie taką sytuację: przeglądasz dużą bazę kodów w wybranym edytorze tekstu i natrafiasz na użycie funkcji lub metody i chcesz ponownie przeanalizować jej implementację. To, co zwykle robię w tym przypadku, to uruchomienie wyszukiwania w całym projekcie w VS Code i otrzymuję natychmiastowe wyniki. Dlaczego więc nie połączyć tego, co najlepsze z obu światów?

Markdown i VS Code wspólnie dostarczają rozwiązania moich dwóch największych problemów z dowolnym systemem do robienia notatek: łatwe pisanie czytelnych notatek przy minimalnym wysiłku formatowania oraz możliwość wyszukiwania informacji w dowolnym momencie .

Więc jak to zbudować? Jest to tak proste, jak utworzenie pustego repozytorium w GitHub, a następnie uruchomienie programu Visual Studio Code for the Web .

Gdy już tam będziesz, kliknij „Otwórz folder”, a VS Code powie, że otwieranie folderów lokalnych nie jest obsługiwane, a zamiast tego pozwoli ci otworzyć folder zdalny. Logując się na swoje konto GitHub, będziesz mógł otworzyć dowolne repozytorium.

Lubię organizować swoje notatki w następujący sposób:

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

W każdym folderze projektu Przydatne polecenia przechowują pojedynczy plik przeceny z przydatnymi poleceniami do zadań, takich jak uruchamianie kontenerów Dockera, uruchamianie testów i tak dalej.

Badania zawierają notatki z badań na różne tematy, głównym celem tutaj jest próba wyjaśnienia sobie pojęć, tak jakbym wyjaśniał je komuś innemu.

Uważam, że zadania wywarły największy wpływ na moją produktywność. Tutaj umieszczam plik Markdown dla każdego przypisanego mi biletu Jira i staram się postępować zgodnie z tym szablonem:

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

To na tyle, jeśli dotarłeś do końca tego posta, dziękuję bardzo i życzę miłego dnia! :)