Wejście Markdown

Raport walidacji

Przykłady walidacji Markdown

Prawidłowy Markdown ma poprawne odstępy i zamknięte bloki kodu. Przykłady:

Prawidłowy Markdown

Prawidłowy

Nieprawidłowy – brak spacji po nagłówku i niezamknięty blok kodu

#API wymaga spacji po #. Blokowi kodu brakuje zamykającego ```.

Nieprawidłowy

Wklej jeden z przykładów do edytora powyżej. Użyj Przykład, aby załadować więcej danych.

Czym jest Walidator Markdown?

Markdown ma reguły składni. Niezamknięte bloki kodu, uszkodzone linki, zniekształcone tabele lub nieprawidłowy HTML mogą powodować problemy z renderowaniem. Walidator Markdown sprawdza dokument i zgłasza typowe problemy. Specyfikacja CommonMark definiuje składnię.

To narzędzie analizuje Markdown i generuje raport walidacji. Działa całkowicie w przeglądarce. Nic nie jest wysyłane na serwer. Do formatowania użyj Formatera Markdown. Do lintowania (reguły stylu) użyj Lintera Markdown.

Jak używać tego narzędzia

1

Wklej lub wczytaj Markdown

Skopiuj Markdown i wklej go do lewego edytora. Możesz też kliknąć Wczytaj, aby załadować plik .md lub .markdown. Przycisk Przykład ładuje przykładowe dane.

2

Sprawdź raport walidacji

Prawy panel pokazuje raport. Zawiera listę problemów takich jak niezamknięte bloki, uszkodzone linki referencyjne, zniekształcone tabele lub puste nagłówki. Pobierz raport, aby go udostępnić.

3

Napraw i ponownie zwaliduj

Napraw problemy w danych wejściowych i ponownie zwaliduj. Do formatowania użyj Formatera Markdown. Do konwersji na HTML użyj Markdown do HTML.

Kiedy walidacja Markdown jest przydatna

Gdy publikujesz dokumentację, pliki README lub treści na GitHub, GitLab lub stronach statycznych jak Jekyll i Hugo, walidacja wykrywa problemy zanim spowodują uszkodzone renderowanie. Specyfikacja GFM definiuje tabele i rozszerzenia. Niezamknięte bloki kodu lub zniekształcone tabele mogą zepsuć całe strony. Sprawdzenie Markdown tutaj daje pewność przed scaleniem lub wdrożeniem.

Treści od wielu autorów lub Markdown generowany przez AI często zawierają subtelne błędy. Walidacja tutaj zapewnia checklistę. Dla spójności stylu (np. poziomy nagłówków, formatowanie list) użyj Lintera Markdown.

Często zadawane pytania

Co sprawdza walidacja Markdown?

Sprawdza typowe problemy, takie jak pominięte poziomy nagłówków (np. przejście z H1 do H3), niezamknięte bloki kodu, błędna składnia linków, niespójne wcięcia list oraz puste znaczniki nagłówków. To najczęstsze przyczyny nieprawidłowego renderowania.

Czy prawidłowy Markdown będzie się renderował poprawnie wszędzie?

Niekoniecznie. Różne renderery Markdown obsługują składnię w różny sposób. Walidacja opiera się na specyfikacji CommonMark. GitHub, GitLab i inne narzędzia dodają własne rozszerzenia. Testuj dokument tam, gdzie zostanie opublikowany, aby mieć pewność.

Czy mogę walidować plik README?

Tak — wklej zawartość pliku README.md do edytora i kliknij Waliduj. To świetny sposób na wykrycie błędów formatowania przed wypchnięciem na GitHub lub GitLab.

Czy istnieje limit rozmiaru pliku?

Nie. Walidacja odbywa się w całości w przeglądarce, więc nie ma żadnych limitów po stronie serwera. Bardzo duże dokumenty mogą potrzebować chwilę dłużej na przetworzenie, ale większość plików README i dokumentacji jest obsługiwana natychmiastowo.

Powiązane narzędzia

Dowiedz się więcej: CommonMark, specyfikacja CommonMark, GitHub Flavored Markdown, Markdown Guide, GitHub, W3C HTML, GitLab, Hugo.