Od jakiegoś czasu sporo programuję, wykorzystując Visual Studio Code. Podczas tworzenia kodu przydaje się również dokumentacja. Ostatnio odkryłam funkcję podglądu plików .md, a także wtyczkę, która umożliwia sprawdzanie składni takich plików.

VS Code – podgląd pliku MD

Na początku wystarczy otworzyć plik o rozszerzeniu .md. Wyświetli się w edytorze. Jednakże po kliknięciu w drugą ikonkę po prawej stronie otworzy się podgląd pliku.

VS Code – wtyczka markdownlint

Jeśli chcemy zachować poprawność składni, warto pobrać sobie takie rozszerzenie jak markdownlint:

Po zamknięciu podglądu pliku .md i jego ponownemu otwarciu widać, że sprawdził składnię i podkreślił uwagi na zielono:

Przykładowo pierwszy problem to brak pustych linii otaczających nagłówek:

A kolejny to zbyt wiele nagłówków najwyższego poziomu w dokumencie:

Wszystkie zmiany, jakie wprowadziłam w istniejącym kodzie, możecie zobaczyć w szczegółach commita.

Wszystkie zasady wtyczki markdownlint możecie przeanalizować na jej GitHubie.