Линтер Markdown

Проверяет Markdown на проблемы стиля: уровни заголовков, ограждения кода, согласованность списков и др. (движок правил без зависимостей)

Ключевые факты

Категория
Разработка и Web
Типы входных данных
textarea, select
Тип результата
text
Покрытие примерами
4
API доступен
Yes

Обзор

Онлайн-линтер Markdown помогает быстро проверить структуру и форматирование ваших документов. Инструмент анализирует текст на наличие ошибок в иерархии заголовков, оформлении списков и блоков кода, предоставляя подробный отчет в текстовом или JSON-формате для поддержания чистоты и единообразия разметки.

Когда использовать

  • Перед публикацией технической документации или статей, написанных в формате Markdown.
  • Для проверки правильности иерархии заголовков и оформления списков в файлах README.
  • При подготовке контента для статических генераторов сайтов, чтобы избежать ошибок рендеринга разметки.

Как это работает

  • Вставьте исходный текст Markdown в поле ввода.
  • Выберите подходящий набор правил: стандартный, расслабленный или строгий.
  • Укажите желаемый формат отчета (простой текст или структурированный JSON).
  • Запустите проверку, чтобы мгновенно получить список найденных несоответствий и рекомендаций по их устранению.

Сценарии использования

Валидация файлов README.md перед отправкой коммита в репозиторий.
Проверка статей для блогов и баз знаний на корректность вложенности заголовков.
Контроль качества разметки в документах, создаваемых несколькими авторами совместно.

Примеры

1. Проверка иерархии заголовков в технической статье

Технический писатель
Контекст
Автор подготовил руководство по API, но случайно пропустил уровень заголовка H3, перейдя от H2 сразу к H4.
Проблема
Нарушение структуры документа, из-за чего автогенерация оглавления работает некорректно.
Как использовать
Скопировать текст статьи в поле ввода, выбрать стандартный набор правил и запустить проверку.
Пример конфигурации
Набор правил: "Стандартный", Формат отчета: "Текстовый отчет".
Результат
Линтер указывает на конкретную строку с ошибкой нарушения последовательности заголовков (например, "Heading levels should only increment by one level at a time").

2. Анализ разметки списков и блоков кода для README

Разработчик ПО
Контекст
Разработчик написал файл README.md для проекта с примерами кода, но не уверен в правильности закрытия блоков кода и единообразии маркеров списков.
Проблема
Неправильно оформленные блоки кода могут сломать отображение страницы проекта на GitHub.
Как использовать
Вставить содержимое README.md, выбрать строгий набор правил и формат отчета JSON для детального разбора.
Пример конфигурации
Набор правил: "Строгий", Формат отчета: "JSON".
Результат
Получен структурированный JSON-отчет со списком всех незакрытых блоков кода и несоответствий в маркерах списков с указанием номеров строк.

Проверить на примерах

markdown

Связанные хабы

FAQ

Какие ошибки форматирования находит этот линтер?

Он проверяет последовательность уровней заголовков, правильность оформления списков, закрытие блоков кода и другие стилистические правила разметки.

Чем отличаются наборы правил (ruleSet)?

Стандартный набор подходит для большинства документов, строгий требует идеального соблюдения спецификаций, а расслабленный игнорирует незначительные отклонения.

Можно ли автоматически исправить ошибки в тексте?

Нет, инструмент предназначен только для анализа и выявления ошибок, предоставляя подробный отчет для ручного исправления.

Зачем нужен формат отчета JSON?

Формат JSON удобен для последующей автоматизированной обработки результатов проверки или интеграции с другими скриптами.

Требуется ли установка дополнительных зависимостей для работы?

Нет, линтер работает непосредственно в браузере на базе встроенного движка правил и не требует установки сторонних пакетов.

Документация API

Конечная точка запроса

POST /ru/api/tools/markdown-linter

Параметры запроса

Имя параметра Тип Обязательно Описание
markdownInput textarea Да -
ruleSet select Нет -
reportFormat select Нет -

Формат ответа

{
  "result": "Processed text content",
  "error": "Error message (optional)",
  "message": "Notification message (optional)",
  "metadata": {
    "key": "value"
  }
}
Текст: Текст

Документация MCP

Добавьте этот инструмент к конфигурации сервера MCP:

{
  "mcpServers": {
    "elysiatools-markdown-linter": {
      "name": "markdown-linter",
      "description": "Проверяет Markdown на проблемы стиля: уровни заголовков, ограждения кода, согласованность списков и др. (движок правил без зависимостей)",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=markdown-linter",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

Вы можете объединять несколько инструментов, например: `https://elysiatools.com/mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp`, максимум 20 инструментов.

Если вы столкнулись с проблемами, пожалуйста, свяжитесь с нами по адресу [email protected]