Bezpłatny Linter Markdown — Sprawdzanie Stylu

Wklej Markdown i natychmiast otrzymaj raport lint z problemami nagłówków, list i stylu.

Wprowadź Markdown

Raport Lint

Przykłady Lint Markdown

Linter zgłasza problemy ze stylem: długie linie, przeskoki nagłówków, mieszane znaczniki list. Przykład:

Markdown z typowymi problemami

Długa linia, przeskok nagłówka (H2 do H3 z pominięciem H1), mieszane znaczniki list - i *.

Przykład

Wklej do edytora powyżej, aby zobaczyć raport lint. Użyj Przykład, aby wczytać więcej.

Czym jest Markdown Linter?

Markdown to lekki język znaczników do dokumentów, plików README i treści internetowych. Linter sprawdza Markdown pod kątem problemów ze stylem i strukturą: niespójne poziomy nagłówków, brakujące puste linie, uszkodzone linki lub formatowanie, które może nie renderować się zgodnie z oczekiwaniami. Specyfikacja CommonMark i GitHub Flavored Markdown (GFM) definiują składnię.

To narzędzie działa w całości w przeglądarce. Markdown jest analizowany lokalnie — nic nie jest wysyłane na serwer. Raport lint wyświetla problemy według wiersza z poziomem ważności (Błąd, Ostrzeżenie, Info). Do formatowania Markdown użyj Markdown Formatter. Do walidacji użyj Markdown Validator.

Jak korzystać z tego narzędzia

1

Wklej lub wczytaj

Wklej Markdown do lewego edytora lub kliknij Wczytaj, aby załadować plik .md, .markdown lub .txt. Użyj Przykład, aby wczytać przykładowe dane z typowymi problemami.

2

Przejrzyj raport lint

Prawy panel pokazuje raport lint z numerami linii i opisami. Popraw problemy w lewym edytorze; raport aktualizuje się automatycznie. Użyj Kopiuj lub Pobierz, aby zapisać raport.

3

Napraw i ponownie uruchom lint

Rozwiąż każdy problem i uruchom ponownie. Do konwersji Markdown na HTML użyj Markdown do HTML. Do generowania spisu treści z nagłówków użyj Generator TOC Markdown.

Kiedy linting Markdown pomaga

Przed commitowaniem dokumentów na GitHub lub publikowaniem w CMS, linting wykrywa problemy, które mogą zepsuć renderowanie lub dezorientować czytelników. Niespójna hierarchia nagłówków sprawia, że spisy treści są zawodne. Uszkodzone linki referencyjne powodują błędy 404. Uruchomienie Markdown tutaj poprawia jakość przed przeglądem.

Strony dokumentacji, pliki README i posty na blogu korzystają na spójnym Markdown. Do konwersji na HTML użyj Markdown do HTML. Do generowania spisu treści z nagłówków użyj Generator TOC Markdown. Do referencji składni użyj Markdown Cheat Sheet.

Często zadawane pytania

Czy moje dane są prywatne?

Tak. Linting działa w całości w przeglądarce. Żadne dane nie są wysyłane na żaden serwer. Możesz to potwierdzić, otwierając kartę Sieć w przeglądarce.

Co sprawdza?

Typowe kontrole obejmują spójność nagłówków, puste linie wokół bloków, formatowanie list, poprawność linków i zgodność z CommonMark/GFM. Dokładne reguły zależą od implementacji.

Linter vs Walidator?

Linter skupia się na stylu i najlepszych praktykach. Walidator sprawdza poprawność składni. Używaj obu dla jakości. Wypróbuj Markdown Validator do walidacji.

Czy obsługuje GFM?

Wiele linterów obsługuje GitHub Flavored Markdown (tabele, listy zadań, przekreślenie). Sprawdź raport pod kątem problemów specyficznych dla GFM.

Czy może automatycznie naprawiać problemy?

To narzędzie zgłasza problemy; naprawiasz je ręcznie. Do formatowania (białe znaki, podziały wierszy) użyj Markdown Formatter.

Powiązane narzędzia

Markdown Formatter Markdown Validator Markdown TOC Generator Markdown to HTML Markdown Cheat Sheet HTML to Markdown JSON Formatter

Składnia Markdown: CommonMark i specyfikacja CommonMark. GitHub Flavored Markdown rozszerza ją. Markdown Guide oferuje samouczki. Zobacz też GitHub, W3C HTML i Jekyll.