Kontrola Markdown
Zkontrolujte Markdown z hlediska stylistických a syntaktických problémů pomocí markdownlint, nástroje pro kontrolu, který používá řada editorů a CI pipeline. Vložte dokument a zobrazte všechna zjištění včetně řádku, pravidla, například MD001, a vysvětlení. Volitelně si nechte zobrazit opravenou verzi, ve které markdownlint automaticky opraví vše, co dokáže, například prázdné řádky, odrážky a mezery.
Často kladené otázky
Která pravidla se kontrolují?
Všechna pravidla, která markdownlint ve výchozím nastavení zapíná, od MD001 (úrovně nadpisů se zvyšují vždy o jednu) až po pravidla pro seznamy, prázdné řádky, bloky kódu, odkazy a zvýraznění. Pravidlo délky řádku MD013 je vypnuté, dokud nenastavíte maximální délku řádku.
Jak vypnu pravidla?
Uveďte je v poli pravidel k vypnutí a oddělte čárkami nebo mezerami; použijte čísla jako MD033 nebo názvy jako no-inline-html. Fungují také vložené komentáře v dokumentu, například <!-- markdownlint-disable MD033 -->.
K čemu slouží možnost oprav?
Použije automatické opravy, které markdownlint nabízí, například přidání prázdných řádků kolem nadpisů a seznamů, sjednocení značek seznamu nebo odstranění koncových mezer, a zobrazí opravený dokument. Zjištění bez automatické opravy zůstávají na ruční opravu.
Která verze markdownlint se používá?
markdownlint 0.42.0, knihovna, na které jsou založené rozšíření markdownlint pro Visual Studio Code a markdownlint-cli2. Při použití stejné verze a výchozí konfigurace hlásí stejná zjištění.
Proč nástroj upozorňuje na můj první nadpis?
Pravidlo MD041 očekává, že dokument začne nadpisem nejvyšší úrovně, a MD025 povoluje pouze jeden takový nadpis. Pokud název přidává vaše platforma, tato pravidla pro daný dokument vypněte.
Kolik zjištění se zobrazí?
Vždy se zobrazí celkový počet a v tabulce je uvedeno prvních 500 zjištění. Opravte první položky a spusťte kontrolu znovu, abyste zobrazili zbývající.