Ключевые факты
- Категория
- Разработка и Web
- Типы входных данных
- textarea, select
- Тип результата
- text
- Покрытие примерами
- 4
- API доступен
- Yes
Обзор
Этот инструмент предназначен для быстрого статического анализа ссылок в документах Markdown. Он позволяет мгновенно находить синтаксические ошибки, неработающие внутренние якоря и пропущенные определения справочных ссылок без отправки внешних сетевых запросов, обеспечивая полную конфиденциальность ваших данных.
Когда использовать
- •Перед публикацией документации или статей в Git-репозиторий для предотвращения неработающих переходов.
- •При редактировании крупных файлов Markdown с большим количеством внутренних перекрестных ссылок и заголовков.
- •Для проверки корректности справочных ссылок (reference-style links) на предмет пропущенных или лишних определений.
Как это работает
- •Вставьте исходный текст в формате Markdown в поле ввода.
- •Выберите уровень проверки: базовый для поиска ошибок формата и битых якорей или строгий для выявления дубликатов и неиспользуемых ссылок.
- •Укажите желаемый формат вывода результатов — текстовый отчет или структурированный JSON.
- •Инструмент мгновенно выполнит локальный синтаксический анализ и отобразит список найденных проблем.
Сценарии использования
Примеры
1. Проверка внутренней навигации в техническом руководстве
Технический писатель- Контекст
- При подготовке объемного руководства пользователя были изменены названия некоторых заголовков, из-за чего внутренние ссылки могли сломаться.
- Проблема
- Необходимо быстро найти все неработающие ссылки на разделы документа без ручного клика по каждой из них.
- Как использовать
- Вставьте текст руководства в поле ввода, выберите уровень проверки "Базовый" и текстовый формат отчета.
- Пример конфигурации
-
Уровень проверки: basic, Формат отчета: text - Результат
- Инструмент выявил ссылки на несуществующие якоря #install-step-2 и #troubleshoot, указав строки с ошибками для быстрого исправления.
2. Оптимизация справочных ссылок в файле README
Разработчик- Контекст
- В файле README.md используется стиль справочных ссылок внизу документа. После удаления некоторых абзацев могли остаться лишние определения.
- Проблема
- Найти неиспользуемые сноски и дублирующиеся ссылки для очистки файла.
- Как использовать
- Скопируйте содержимое README.md, выберите уровень проверки "Строгий" и формат отчета "JSON".
- Пример конфигурации
-
Уровень проверки: strict, Формат отчета: json - Результат
- Получен JSON-отчет со списком из трех неиспользуемых определений ссылок в конце файла, которые можно безопасно удалить.
Проверить на примерах
markdownСвязанные хабы
FAQ
Отправляет ли инструмент запросы к внешним сайтам для проверки URL?
Нет, проверка выполняется полностью статически в вашем браузере. Внешние сетевые запросы не отправляются.
Что проверяется на базовом уровне (basic)?
Проверяется корректность синтаксиса разметки ссылок и соответствие внутренних якорей (например, #section) существующим заголовкам в документе.
Для чего нужен строгий уровень проверки (strict)?
В строгом режиме инструмент дополнительно находит дублирующиеся якоря заголовков и объявленные, но неиспользуемые справочные ссылки.
Поддерживаются ли справочные ссылки (reference-style)?
Да, валидатор проверяет наличие соответствующих определений для всех ссылок вида [текст][идентификатор].
В каком формате я могу получить результаты?
Вы можете выбрать наглядный текстовый отчет с описанием ошибок или структурированный JSON для автоматического разбора.