Preskoči na vsebino

Markdown linter

Najdi zlomljene povezave, preskočene ravni naslovov in nezaključene kodni bloki v Markdown-u.

Vhod
Poti obstoječih datotek (ena na vrstico, izbirno)
Izhod

Markdown linter

Prilepite Markdown dokument in to orodje sporoči, kaj je narobe z njim, eno ugotovitev na vrstico, z natančno številko vrstice. Vedno preverja neuparene **krepko**, __krepko__, ~~črtano~~ in `koda` oznake, neuravnovešene [ ] oklepaje povezav in prazne cilj linka ali slike, ravni naslovov, ki preskočijo raven (H1, ki mu neposredno sledi H3), in ograjevane kodni bloki, ki so odprti, vendar nikoli zaključeni — vrsta napake skladnje, ki se lepo prikaže v enem Markdown motorju in se prekine v drugem.

Možnosti dodajo preverke, ki so bolj kot skladnja kot doslednost. Vklopite preverjanje referenc povezav, da ujamete [besedilo][ref] povezavo brez ujemajoče se [ref]: url definicije spodaj nje in definicije, ki so definirane, vendar nikoli omenjene. Preverjanje podvojenih naslovov označuje ponavljajočo se besedilo naslova in več kot en naslov vrhnje ravni, kar zmede bralce in generatorje kazala vsebine. Preverjanje doslednosti seznama ujame seznam z oznako, ki se prestavi s - na * na sredi, ali oštevilčene točke, ki izpadejo iz zaporedja. Zahtevate lahko tudi jezik na vsakem ograjevanem kodu bloku, označiti prazno mesto na koncu vrstice (niz točno dveh presledkov je izpuščen, ker je to namenski Markdown prelom vrstice), in omejiti dolžino vrstice. Prilepite seznam obstoječih poti datotek v drugo polje in lokalni cilj linka in slike se preverita glede na njega, zato se preimenovana ali izbrisana datoteka pojavi kot zlomljena povezava, preden objavljate.

Linter enako obravnava prelome vrstic Windows (CRLF) in Unix (LF), in preverke, ki bi se zmotile pri vsebini koda — oznake, povezave, naslovi, seznami, prazno mesto na koncu vrstice — se preskočijo za besedilo znotraj ograjevanega koda bloka. Preverjanje dolžine vrstice se še vedno uporablja povsod. Plošča rezultatov poudari vsako vrstico ugotovitve v rdeči barvi, zato je dolg poročilo enostavno pregledati, in skupna vrednost zgoraj prikazuje skanirane vrstice, najdene težave in preštete naslove.

Vse se izvršava lokalno v vašem brniku. Dokument, ki ga prilepite, in vse poti datotek, ki jih dodate za preverjanje povezav, se nikdar ne naložijo nikamor. Ko končate, kopirajte poročilo, preuzmite ga kot datoteko .txt ali ga pošljite na vnos drugega orodja, da nadaljujete z delom.

FAQ

Ali je to popolnoma analizirano Markdown, kot bi ga storil upodabljač?
Ne. To je provjerivač na osnovi vrstice, zgrajen za zajemanje pogostih napak — nepreteklane oznake, zlomljene povezave, preskočene ravni naslovov, nezaključeni kodni ograjevanci — ne popolni CommonMark razčlenjevalnik, zato je nenavaden konstrukt včasih lahko spregledan ali preostrno označen.
Zakaj niz natanko dveh zaostankov presledkov ni označen?
Dva zaostanka presledka sta standardni Markdown skladnji za trd prelom vrstice, zato je prepuščeno. Eno zaostalo mesto ali zaostali tabulator sta označena, ker sta skoraj zagotovo naključna.
Kaj se šteje kot podvojen naslov?
Besedilo naslova se primerja brez razlike med velikimi in malimi črkami po obrezovanju, zato se "Setup" in "setup" obravnavata kot isti naslov.
Kako lahko preveriš povezave v primerjavi s pravimi datotekami v svojem projektu?
Prilepite eno relativno pot na vrstico v drugo polje — enake poti, na katere kažejo vaše povezave, kot so docs/setup.md. Lokalni cilj linka in slike, ki niso na tem seznamu, so označeni; zunanji URL-ji in #anchors so vedno preskočeni.
Ali je moj dokument naložen nekje?
Ne. Preverjanje se izvrši v celoti v vašem brskalniku — vaš Markdown in vse poti datotek, ki jih dodate, ostanejo v vaši napravi.