September 23, 2021

wordCount 1 min.

Praca z plikami Markdown/MD w Visual Studio

Plik README.md chyba nie trzeba przedstawiać nikomu. Jego obecność to standard na GitHub, bądź GitLab. Pliki w formacie Markdown pozwalają na szybkie i schludne dokumentowanie projektu.

Na marginesie - ta strona, jej zawartość, też jest stworzona przy pomocy plików w formacie Markdown 😄.

Tworzenie pliku jest proste - wystarczy notatnik. Co jednak z podglądem? Każdorazowo trzeba wrzucić plik do repozytorium, ale jest to męczące i nieefektywne. Innym rozwiązaniem jest wtyczna do przeglądarki - korzystałem z tego, ale bywa, że wtyczka potrafi być zawodna, lub źle działa. Jest jeszcze jedno rozwiązanie.

Rozszerzenie do Visual Studio - Markdown Editor

Markdown Editor autorstwa Madsa Kristensena jest to rozszerzenie do Visual Studio 20019 (dla starszych wersji też działa) oferuje podgląd edytowanego pliku MD.

Co mi się bardzo podoba w tej wtyczce, to udostępnione akcje pod Quick Actions and Refactorings…, które pomagają w formatowaniu zawartości pliku.

Oto jak zainstalować rozszerzenie:

  1. W menu znajdujemy Extensions > Manage Extensions
  2. W pole wyszukiwania należy wpisać markdown editor.
  3. Klikamy w przycisk Download.