Linter Markdown
Sprawdzaj Markdown pod kątem problemów ze stylem i składnią za pomocą markdownlint, lintera używanego przez wiele edytorów i potoków CI. Wklej dokument, aby zobaczyć wszystkie wyniki wraz z numerem wiersza, regułą, taką jak MD001, i wyjaśnieniem. Opcjonalnie możesz uzyskać poprawioną wersję, w której markdownlint koryguje możliwe do naprawienia elementy, takie jak puste wiersze, znaczniki list i odstępy.
Najczęściej zadawane pytania
Które reguły są sprawdzane?
Wszystkie reguły domyślnie włączone w markdownlint, od MD001 (poziomy nagłówków zwiększają się o jeden) po reguły dotyczące list, pustych wierszy, bloków kodu, linków i wyróżnień. Reguła długości wiersza MD013 jest wyłączona, chyba że ustawisz maksymalną długość wiersza.
Jak wyłączyć reguły?
Wymień je w polu reguł do wyłączenia, oddzielając przecinkami lub spacjami. Użyj numerów, takich jak MD033, lub nazw, takich jak no-inline-html. Działają też komentarze inline w dokumencie, na przykład <!-- markdownlint-disable MD033 -->.
Do czego służy opcja naprawiania?
Stosuje automatyczne poprawki oferowane przez markdownlint, takie jak dodanie pustych wierszy wokół nagłówków i list, ujednolicenie znaczników list lub usunięcie końcowych spacji, a następnie wyświetla poprawiony dokument. Wyniki bez automatycznej poprawki pozostają do ręcznego usunięcia.
Która wersja markdownlint jest używana?
markdownlint 0.42.0, biblioteka, na której opierają się rozszerzenie markdownlint dla Visual Studio Code i markdownlint-cli2. Przy tej samej wersji i domyślnej konfiguracji zgłaszają te same wyniki.
Dlaczego narzędzie zgłasza problem z moim pierwszym nagłówkiem?
Reguła MD041 wymaga, aby dokument rozpoczynał się nagłówkiem najwyższego poziomu, a MD025 dopuszcza tylko jeden taki nagłówek. Jeśli platforma dodaje tytuł samodzielnie, wyłącz te reguły dla dokumentu.
Ile wyników jest wyświetlanych?
Zawsze podawana jest łączna liczba, a pierwsze 500 wyniki są wymienione w tabeli. Popraw najpierw te pozycje i ponownie uruchom sprawdzanie, aby zobaczyć pozostałe.