Markdown lintelés
Ellenőrizze a Markdown dokumentumot stílusbeli és szintaktikai hibákra a sok szerkesztő és CI-folyamat által használt markdownlinttel. Illesszen be egy dokumentumot, majd tekintse meg az összes találatot a sorszámmal, a szabállyal (például MD001) és a magyarázattal együtt. Opcionálisan javított változatot is kérhet, amelyben a markdownlint kijavítja, amit tud, például az üres sorokat, a listaelemek jelölőit és a szóközöket.
Gyakran ismételt kérdések
Mely szabályokat ellenőrzi?
A markdownlint által alapértelmezés szerint bekapcsolt összes szabályt, az MD001-től (a címsorszint mindig eggyel nő) a listákra, üres sorokra, kódblokkokra, hivatkozásokra és kiemelésre vonatkozó szabályokig. A sorhosszra vonatkozó MD013 szabály ki van kapcsolva, kivéve, ha megad egy maximális sorhosszt.
Hogyan kapcsolhatom ki a szabályokat?
Sorolja fel őket a kikapcsolandó szabályok mezőben, vesszővel vagy szóközzel elválasztva; számokat, például MD033-at, vagy neveket, például no-inline-html-t használjon. A dokumentumba írt megjegyzések, például a <!-- markdownlint-disable MD033 -->, szintén működnek.
Mit csinál a javítási beállítás?
Alkalmazza a markdownlint által kínált automatikus javításokat, például üres sorokat szúr be a címsorok és listák köré, egységesíti a listaelemek jelölőit vagy eltávolítja a záró szóközöket, majd megjeleníti a javított dokumentumot. Az automatikusan nem javítható találatokat Önnek kell kézzel kijavítania.
A markdownlint melyik verzióját használja?
A markdownlint 0.42.0 könyvtárat, amelyre a Visual Studio Code-hoz készült markdownlint-bővítmény és a markdownlint-cli2 épül. Azonos verzió és alapértelmezett konfiguráció mellett ugyanazokat a találatokat adják.
Miért jelez hibát az első címsoromnál?
Az MD041 szabály megköveteli, hogy a dokumentum felső szintű címsorral kezdődjön, az MD025 pedig csak egyet engedélyez. Ha a platform automatikusan hozzáadja a címet, kapcsolja ki ezeket a szabályokat a dokumentumnál.
Hány találat jelenik meg?
A program mindig megadja a találatok teljes számát, a táblázatban pedig az első 500 találat szerepel. Javítsa ki az elsőket, majd futtassa újra az ellenőrzést a többi megtekintéséhez.