Ключевые факты
- Категория
- Текст и письмо
- Типы входных данных
- textarea, select, checkbox
- Тип результата
- html
- Покрытие примерами
- 4
- API доступен
- Yes
Обзор
Этот инструмент позволяет быстро проверить качество и стиль разметки Markdown на соответствие 15 правилам markdownlint и 2 правилам китайской типографики. Он находит ошибки форматирования, такие как пропущенные уровни заголовков, лишние пробелы и отсутствие указания языка в блоках кода, а также автоматически исправляет безопасные дефекты разметки.
Когда использовать
- •Перед публикацией документации или файлов README в репозиториях для обеспечения единого стиля оформления.
- •При необходимости быстро исправить мелкие ошибки разметки, такие как лишние пустые строки или концевые пробелы, в автоматическом режиме.
- •Для проверки текстов со смешанным использованием китайских и латинских символов на соответствие правилам типографики.
Как это работает
- •Вставьте текст в формате Markdown в текстовое поле ввода.
- •Выберите подходящий набор правил (По умолчанию, Строгий или Мягкий) и включите или отключите опцию автоматического исправления.
- •Инструмент разобьет документ на блоки, проанализирует их с помощью встроенного движка правил и сформирует отчет с указанием строк и типов ошибок, применив безопасные правки к тексту.
Сценарии использования
Примеры
1. Исправление разметки файла README
Технический писатель- Контекст
- Разработчики часто коммитят файлы README с хаотичной разметкой: смешивают маркеры списков, забывают указывать язык для блоков кода и оставляют пробелы на концах строк.
- Проблема
- Необходимо быстро привести файл README.md к единому стандарту оформления без ручного редактирования каждой строки.
- Как использовать
- Скопируйте содержимое README в поле ввода, выберите набор правил «По умолчанию», активируйте опцию «Авто-исправление безопасных» и запустите проверку.
- Пример конфигурации
-
ruleSet: "default", autoFix: true - Результат
- Инструмент автоматически заменил все маркеры списков на дефисы, удалил концевые пробелы и вывел предупреждение о необходимости указать язык программирования для блока кода.
2. Проверка структуры заголовков в документации
Редактор базы знаний- Контекст
- При написании длинных статей авторы иногда нарушают иерархию заголовков, например, перескакивают с H1 сразу на H3.
- Проблема
- Выявить нарушения структуры документа и исправить мелкие недочеты форматирования.
- Как использовать
- Вставьте текст статьи в поле ввода, выберите «Строгий» набор правил и запустите анализ.
- Пример конфигурации
-
ruleSet: "strict", autoFix: true - Результат
- Получен отчет с указанием конкретных строк, где нарушена вложенность заголовков (правило MD001), а лишние пустые строки между разделами были удалены автоматически.
Проверить на примерах
markdownСвязанные хабы
FAQ
Какие ошибки исправляются автоматически?
Автоматически исправляются только безопасные дефекты: удаляются концевые пробелы, лишние пустые строки, нормализуются маркеры списков и добавляется финальный перевод строки.
Что делает правило CN001?
Оно проверяет наличие пробела между китайскими и латинскими символами или цифрами для улучшения читаемости текста.
Чем отличаются наборы правил?
Набор «Строгий» включает жесткие ограничения (например, длину строки), «По умолчанию» проверяет базовый стиль и типографику, а «Мягкий» скрывает предупреждения о стиле, оставляя только критические ошибки.
Будет ли изменен исходный текст при обнаружении неверной иерархии заголовков?
Нет, такие структурные проблемы, как пропуск уровней заголовков (MD001), только выводятся в отчете для ручного исправления.
Можно ли использовать инструмент для проверки файлов README перед коммитом?
Да, инструмент идеально подходит для быстрой валидации файлов README.md и другой проектной документации перед отправкой в Git.