Markdown i Obsidian – dokumentowanie na miarę 21 wieku

Markdown to sposób zapisu/formatowania plików tekstowych, które przez swoją charakterystykę generują dokumenty nadające się do publikacji. Nie jest potrzebny żaden edytor tekstu typu Word. Do tej pory najczęściej spotykałem takie pliki na GitHubie, nie mając świadomości czym są pod spodem (bo wyglądają jak normalny, sformatowany tekst).

Markdown i Obsidian

Obsidian, to tzw. pandemiczny edytor (napisany w czasach pierwszych lockdownów). Nie ma nawet jeszcze stabilnej wersji 1.0, a już coraz częściej się o nim słyszy i moje pierwsze próby wykorzystania wygenerowały dużo wow.

Poza tym że Obsidian pozwala pisać tekst, co możemy robić nawet w zwykłym notatniku, to pozwala od razy na podgląd plików, tagowanie, linkowanie notatek (bo to notatki piszemy i łączymy w całość linkami).

Pisząc jeden dokument, tak naprawdę piszemy wiele notatek i na jednej stronie linkujemy je tworząc jeden spójny dokument. Nad każdą notatką pracuje się osobno, nie ma więc problemu by skupiać się tylko nad konkretnymi wątkami w oderwaniu od całości, a całość robi się automatycznie. To są składowe które czynią Markdown i Obsidian doskonałym połaczeniem.

Wersjonowanie – GitHub i OneDrive

Praca nad pojedynczymi notatkami powoduje od razu myśli, a może by wersjonować dokumentację na poziomie atomowym, a nie całości? Szczególnie że Obisidian to zwykła aplikacja która operuje na lokalnie trzymanych plikach tekstowych. Możemy jed modyfikować w Obsidiania, ale nic nie stoi na przeszkodzie żeby robić to w dowolnie innym edytorze (VSCode, Notepad). No to lecimy dalej, OneDrive i GitHub.

Z zebranych przeze mnie dobrych praktyk, co nie było łatwe bo ile osób tyle różnych zastosowań Obsidiana (jednak większość ludzi korzysta z niego do pisania bieżących notatek, czasami pisania prac naukowych). Pomysł jest żeby dokumenty trzymać na OneDrive.

OneDrive

OneDrive w darmowej wersji (wystarczy założyć konto) udostępnia 5 GB przestrzeni. Na pliki tekstowe i może trochę grafik jest to więcej niż potrzeba. OneDrive świetnie się synchronizuje, możemy mieć dostęp do plików z wielu lokalizacji, czy to przez witrynę internetową czy to ze smarfona. Dodatkowo mamy domyślne backupy, tj. Microsoft automatycznie przechowuje kilka ostatnich wersji każdego pliku, oraz 30 dni po jego skasowaniu. Na wypadek przypadkowego skasowania pliku lub zaszyfrowania przez Ransomware – jesteśmy w stanie przywrócić poprawną wersje plików.

GitHub

Drugim składnikiem który mi naszedł na myśl, to GitHub. Od już jakiegoś czasu darmowe konto GitHuba umożliwia tworzenie prywatnych repozytoriów. Nic nie stoi na przeszkodzie by trzymać dodatkowo wszystko w repo na GitHubie i automatycznie robić commity. Do tego stopnia automatycznie żeby zrobić zadanie w task schedulerze które co kilka minut będzie dokonywało synchronizacji.

To nam daje kolejną opcję, możemy pliki modyfikować bezpośrednio na GitHubie, albo możemy mieć repo GitHuba na wszystkich komputerach z których korzystamy (np. gdy nie chcemy mieć wszędzie podpiętego OneDrive).

Przykład własny – notatki z konfiguracji repo na GitHubie

Jako przykład zacząłem sobie spisywać notatki z konfiguracji synchronizacji przykładowego Vaulta Obsidiana z GitHubem. Po lewej mamy wszystkie notatki, które mogą być rozrzucone po strukturze katalogów, dodane pliki graficzne, a w środku notatka która łączy wszystkie pozostałe.

Praktyczne wykorzystanie Obsidiana do spisania na przyszłość jak konfigurowałem repozytorium GitHuba
Praktyczne wykorzystanie Obsidiana do spisania na przyszłość jak konfigurowałem repozytorium GitHuba

Po prawej w tym samym oknie wyświetliłem widok docelowy dokumentu, tam gdzie treści notatek zostały włączone do ostatecznego dokumentu.

Ostateczne gotowy projekt dokumentacji możemy wyeksportować do PDFa.

Podsumowanie

Ok, wymaga to przyswojenia trochę wiedzy jak tworzyć dokumenty typu Markdown, na razie najwięcej z tego korzystają studenci, bo zastępuje im Latexa, ale sama prostota edycji i linkowanie między sobą poszczególnych części przedstawia się bardzo obiecująco.

Zachęcam do wypróbowania, do celów prywatnych i freelancerskich jest darmowy – Obsidian.MD

Dodaj komentarz

Twój adres e-mail nie zostanie opublikowany. Wymagane pola są oznaczone *