Markdown Lint
Skontrolujte Markdown, či neobsahuje problémy so štýlom a syntaxou, pomocou markdownlint, nástroja na kontrolu, ktorý používajú mnohé editory a CI pipeline. Vložte dokument a zobrazte všetky nálezy s číslom riadka, pravidlom, napríklad MD001, a vysvetlením. Voliteľne získate opravenú verziu, v ktorej markdownlint opraví, čo dokáže, napríklad prázdne riadky, značky zoznamu a medzery.
Často kladené otázky
Ktoré pravidlá sa kontrolujú?
Všetky pravidlá, ktoré markdownlint predvolene zapína, od MD001 (úrovne nadpisov sa zvyšujú o jeden) až po pravidlá pre zoznamy, prázdne riadky, bloky kódu, odkazy a zvýraznenie. Pravidlo dĺžky riadka MD013 je vypnuté, pokiaľ nenastavíte maximálnu dĺžku riadka.
Ako vypnem pravidlá?
Uveďte ich v poli pravidiel na vypnutie a oddeľte ich čiarkami alebo medzerami; použite čísla, napríklad MD033, alebo názvy, napríklad no-inline-html. Fungujú aj vložené komentáre v dokumente, napríklad <!-- markdownlint-disable MD033 -->.
Čo robí možnosť opravy?
Použije automatické opravy, ktoré markdownlint ponúka, napríklad pridanie prázdnych riadkov okolo nadpisov a zoznamov, zjednotenie značiek zoznamu alebo odstránenie koncových medzier, a zobrazí opravený dokument. Nálezy bez automatickej opravy zostanú na ručné opravenie.
Ktorá verzia markdownlint sa používa?
markdownlint 0.42.0, knižnica, na ktorej sú postavené rozšírenie markdownlint pre Visual Studio Code a markdownlint-cli2. Pri rovnakej verzii a predvolenej konfigurácii hlásia rovnaké nálezy.
Prečo nástroj hlási problém s mojím prvým nadpisom?
Pravidlo MD041 vyžaduje, aby sa dokument začínal nadpisom najvyššej úrovne, a MD025 povoľuje iba jeden taký nadpis. Ak vaša platforma pridáva názov sama, tieto pravidlá pre dokument vypnite.
Koľko nálezov sa zobrazí?
Vždy sa uvedie celkový počet a v tabuľke sa zobrazí prvých 500 nálezov. Opravte prvé nálezy a spustite kontrolu znova, aby ste videli zvyšné.