Ugrás a tartalomhoz

Markdown linter

Hibás linkek, kihagyott fejléc szintek és lezáratlan kódblokkok keresése Markdownban.

Bemenet
Meglévő fájl elérési útvonalak (soronként egy, opcionális)
Kimenet

Markdown linter

Illesszen be egy Markdown dokumentumot, és az eszköz pontosan jelenti, mi a hiba vele — soronként egy megállapítás, sorszámmal. Mindig ellenőrzi a nem párosított **félkövér**, __félkövér__, ~~áthúzott~~ és `kód` jelölőket, kiegyensúlyozatlan [ ] link zárójeleket és üres link vagy képcélokat, fejléc szinteket, amelyek szintet ugranak (egy H1-et közvetlenül egy H3-at követi), és bekerített kódblokokat, amelyek megnyílnak, de soha nem zárulnak — az olyan szintaxishiba, amely jól jelenik meg az egyik Markdown motorban, de megtörik a másikban.

A lehetőségek olyan ellenőrzéseket adnak hozzá, amelyek inkább a konzisztenciáról szólnak, mint a szintaxisról. A link referencia ellenőrzésének bekapcsolásához egy [szöveg][ref] linket kell ellenőrizni a hozzá tartozó [ref]: url definíció nélkül az alatta, és a definiáltak, de soha nem hivatkozott definíciók. Az ismétlődő fejléc ellenőrzése ismételt fejléc szöveget és több mint egy felső szintű fejlécet jelöl meg, amely zavarja az olvasókat és a tartalomjegyzék-generátorokat. A lista konzisztenciájának ellenőrzése olyan golyólistát észlel, amely félúton vált a - ról a * -ra, vagy sorszámított elemek, amelyek kiesnek a sorrendből. Megkövetelheti a nyelvet minden bekerített kódblokkon, jelölheti az utolsó szóközt (egy pontosan két szóköz futása figyelmen kívül marad, mivel ez egy szándékos Markdown sortörés), és korlátozhatja a sor hosszát. Egy lista meglévő fájl elérési útvonalakból illeszti be a második mezőbe, és a helyi link és képcélok ellenőrizve lesznek rajta, így az átnevezett vagy törölt fájl a közzétételezés előtt széttöredezett linkként jelenik meg.

A linter a Windows (CRLF) és Unix (LF) sorszakasztókat ugyanúgy kezeli, és az ellenőrzések, amelyek félremennének a kódtartalmon — jelölők, linkek, fejlécek, listák, sondaki szóköz — kimaradnak a bekerített kódblokkon belüli szövegtől. A sorhossz-ellenőrzés még mindig mindenhol érvényes. A kimeneti panel piros színnel emeli ki az összes megállapítási sort, így egy hosszú jelentés könnyen áttekinthető, és felette a szám a besövetett sorokat, a megtalált problémákat és a számlált fejléceket mutatja.

Mindenki helyileg fut a böngészőjében. Az általunk beillesztett dokumentum és az összes fájl elérési útja a link ellenőrzéséhez soha nem kerül fel sehova. Ha végzett, másolja ki a jelentést, töltse le .txt fájlként, vagy küldje el egy másik eszköz bemenetéhez, hogy folytassa a munkat.

Gyakori kérdések

Teljesen elemzi a Markdownt, mint egy renderer?
Nem. Ez egy sor alapú heurisztikus ellenőrző, amely általános hibákat kap — nem párosított jelölők, hibás linkek, kihagyott fejléc szintek, lezáratlan kódkerítések — nem teljes CommonMark elemző, így egy szokatlan konstruktum alkalmanként kihagyható vagy túl jelölhető.
Miért nincs megjelölve a két sondaki szóköz futása?
A két szóköz a szabvány Markdown szintaxis kemény sortöréshez, így figyelmen kívül hagyják. Egy szóköz vagy egy sondó tabulátor jelölve van, mivel ezek szinte mindig véletlen.
Mi számít ismétlődő fejlécnek?
A fejléc szövegét a kis-és nagybetűk megkülönböztetésén kívül hasonlítják össze, ezért a "Setup" és a "setup" ugyanaz a fejlécnek tekintendő.
Hogyan ellenőrizhetem a linkeket a projekt valós fájljaival szemben?
Soronként egy relatív útvonalat illesszen be a második mezőbe — ugyanazok az útvonalak, amelyekre a linkek mutatnak, például docs/setup.md. A helyi link és képcélok, amelyek nem szerepelnek ebben a listában, jelölve vannak; a külső URL-ek és #horgonyok mindig kimaradnak.
Fel van töltve az én dokumentumom valahova?
Nem. Az ellenőrzés teljes egészében a böngészőjében fut — az Ön Markdownja és az összes fájl elérési útja az eszközön marad.