Przejdź do treści

Markdown linter

Znajduj przerwane linki, brakujące poziomy nagłówków i niezamknięte bloki kodu w Markdown.

Wejście
Istniejące ścieżki plików (jeden na wiersz, opcjonalnie)
Wynik

Markdown linter

Wklej dokument Markdown i to narzędzie będzie zgłaszać, co się w nim nie zgadza, jeden wynik na wiersz, z dokładnym numerem wiersza. Zawsze sprawdza niedopasowane znaczniki **bold**, __bold__, ~~strikethrough~~ i `code`, niezrównoważone nawiasy [ ] i puste cele linków lub obrazów, poziomy nagłówków, które pomijają poziom (H1 bezpośrednio następowany H3) i fenced bloki kodu, które są otwarte, ale nigdy zamknięte — rodzaj błędu składni, który może prawidłowo renderować się w jednym Markdown engine i pęknie w innym.

Opcje dodają kontrole, które dotyczą raczej spójności niż składni. Włącz sprawdzanie odwołań do linków, aby uchwycić link [text][ref] bez odpowiedniej definicji [ref]: url poniżej i definicje, które są zdefiniowane, ale nigdy nie są używane. Sprawdzanie duplikatów nagłówków oznacza powtórzony tekst nagłówka i więcej niż jeden nagłówek najwyższego poziomu, co dezorientuje czytników i generatory spisu treści. Sprawdzanie spójności list uchwytuje listę z punktami, która przełącza się z - na * w połowie lub pozycje numerowane, które wychodzą z sekwencji. Możesz również wymagać języka na każdym fenced bloku kodu, oflagować białe znaki na końcu wiersza (bieg dokładnie dwóch spacji jest pozostawiony, ponieważ to jest celowy Markdown break wiersza) i ograniczyć długość wiersza. Wklej listę istniejących ścieżek plików w drugie pole i lokalne cele linków i obrazów zostaną sprawdzone, więc zmieniona nazwa lub usunięty plik pojawi się jako przerwany link przed opublikowaniem.

Linter obsługuje Windows (CRLF) i Unix (LF) końce wierszy w ten sam sposób, a kontrole, które mogłyby się nie powieść na zawartości kodu — znaczniki, linki, nagłówki, listy, białe znaki na końcu wiersza — są pomijane dla tekstu wewnątrz fenced bloku kodu. Sprawdzanie długości wiersza nadal ma zastosowanie wszędzie. Panel wyjścia podkreśla każdy wiersz wyniku na czerwono, dzięki czemu długi raport jest łatwy do przeszukania, a liczba wyników powyżej pokazuje skanowane wiersze, znalezione problemy i policzane nagłówki.

Wszystko działa lokalnie w Twojej przeglądarce. Dokument, który wklejasz, i wszystkie ścieżki plików, które dodajesz do sprawdzania linków, nigdy nie są nigdzie przesyłane. Gdy skończysz, skopiuj raport, pobierz go jako plik .txt, lub wyślij go do wejścia innego narzędzia, aby kontynuować pracę.

Częste pytania

Czy w pełni parsuje Markdown jak by to zrobił renderer?
Nie. Jest to kontroler oparty na wierszach zbudowany do łapania typowych pomyłek — niedopasowanych znaczników, przerwanych linków, brakujących poziomów nagłówków, niezamkniętych fenced bloków kodu — nie pełny parser CommonMark, więc nieobyczajna konstrukcja czasami może być pominięta lub oznaczona zbyt dużo.
Dlaczego bieg dwóch spacji na końcu nie jest oznaczony?
Dwie spacje na końcu wiersza to standardowa składnia Markdown na twardy break wiersza, więc są pozostawione. Jedna spacja na końcu wiersza lub tabulator na końcu jest oznaczony, ponieważ są to prawie zawsze przypadki.
Co się liczy jako duplikat nagłówka?
Tekst nagłówka jest porównywany bez uwzględniania wielkości liter po przycinięciu, więc "Setup" i "setup" są traktowane jako ten sam nagłówek.
Jak sprawdzić linki względem rzeczywistych plików w moim projekcie?
Wklej jedną względną ścieżkę na wiersz do drugiego pola — te same ścieżki, do których wskazują Twoje linki, na przykład docs/setup.md. Lokalne cele linków i obrazów, które nie znajdują się na liście, są oznaczone; zewnętrzne adresy URL i #anchors są zawsze pomijane.
Czy mój dokument jest wgrany gdziekolwiek?
Nie. Sprawdzanie przebiega całkowicie w Twojej przeglądarce — Twój Markdown i wszystkie ścieżki plików, które wprowadzisz, pozostają na Twoim urządzeniu.