Проверка 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 замечаний. Исправьте первые и запустите проверку еще раз, чтобы увидеть остальные.