Лінтер 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 результатів. Виправте спершу їх і запустіть перевірку ще раз, щоб побачити решту.