Markdown проверка
Проверете Markdown за стилови и синтактични проблеми с markdownlint — инструмент за проверка, използван от много редактори и CI конвейери. Поставете документ и получете всяка открита грешка с нейния ред, правило, например MD001, и обяснение. По желание можете да получите коригирана версия, в която markdownlint поправя каквото може, например празни редове, маркери за списъци и интервали.
Често задавани въпроси
Кои правила се проверяват?
Всички правила, които markdownlint включва по подразбиране — от MD001 (нивата на заглавията се повишават с едно) до правилата за списъци, празни редове, блокове с код, връзки и подчертаване. Правилото за дължина на реда MD013 е изключено, освен ако не зададете максимална дължина.
Как да изключа правила?
Избройте ги в полето за изключване на правила, разделени със запетаи или интервали, като използвате номера, например MD033, или имена, например no-inline-html. Работят и вградени коментари в документа, като <!-- markdownlint-disable MD033 -->.
Какво прави опцията за корекция?
Тя прилага автоматичните корекции, предлагани от markdownlint, например добавя празни редове около заглавия и списъци, уеднаквява маркерите за списъци или премахва интервалите в края на редовете, след което показва коригирания документ. Откритите проблеми без автоматична корекция остават за ръчно поправяне.
Коя версия на markdownlint се използва?
markdownlint 0.42.0 — библиотеката, върху която са изградени разширението markdownlint за Visual Studio Code и markdownlint-cli2. При еднаква версия и конфигурация по подразбиране те откриват едни и същи проблеми.
Защо отчита проблем с първото ми заглавие?
Правило MD041 изисква документът да започва със заглавие от най-високо ниво, а MD025 допуска само едно такова заглавие. Ако платформата ви добавя заглавието автоматично, изключете тези правила за документа си.
Колко проблема се показват?
Винаги се показва общият брой, а първите 500 проблема се изброяват в таблицата. Поправете първите и пуснете проверката отново, за да видите останалите.