Markdown lintimine
Kontrollige Markdown stiili- ja süntaksivigu markdownlintiga, mida kasutavad paljud redaktorid ja CI-konveierid. Kleepige dokument ja vaadake iga leidu koos rea, reegli (nt MD001) ja selgitusega. Soovi korral saate parandatud versiooni, kus markdownlint parandab võimalusel näiteks tühjad read, loendimärgid ja tühikukasutuse.
Korduma kippuvad küsimused
Milliseid reegleid kontrollitakse?
Kõiki reegleid, mille markdownlint vaikimisi lubab: alates reeglist MD001 (pealkirjatasemed suurenevad ühe võrra) kuni loendite, tühjade ridade, koodiplokkide, linkide ja rõhutuse reegliteni. Rea pikkuse reegel MD013 on välja lülitatud, kui te ei määra rea maksimum-pikkust.
Kuidas reegleid välja lülitada?
Loetlege need väljal „rules to disable”, eraldades komade või tühikutega; kasutage näiteks numbreid MD033 või nimesid no-inline-html. Toimivad ka dokumendisisesed kommentaarid, näiteks <!-- markdownlint-disable MD033 -->.
Mida paranduse valik teeb?
See rakendab markdownlinti pakutavaid automaatparandusi, näiteks lisab pealkirjade ja loendite ümber tühjad read, ühtlustab loendimärgid või eemaldab lõputühikud, ning kuvab parandatud dokumendi. Leiud, millele automaatparandust pole, jäävad käsitsi parandada.
Millist markdownlinti versiooni kasutatakse?
markdownlint 0.42.0, teek, millel põhinevad Visual Studio Code'i markdownlinti laiendus ja markdownlint-cli2. Sama versiooni ja vaikekonfiguratsiooni korral annavad need samad leiud.
Miks annab see esimese pealkirja kohta veateate?
Reegel MD041 eeldab, et dokument algab kõrgeima taseme pealkirjaga, ning MD025 lubab ainult üht sellist pealkirja. Kui teie platvorm lisab pealkirja ise, lülitage need reeglid dokumendi jaoks välja.
Mitu leidu kuvatakse?
Leidude koguarv kuvatakse alati ning tabelis on loetletud esimesed 500 leidu. Parandage need ja käivitage kontroll uuesti, et näha ülejäänuid.