bwplotka/mdox

Что это?

Ключевые возможности

• 01Форматирует Markdown-файлы на месте, приводя их к единому стилю GFM.
• 02Автоматически генерирует содержимое блоков кода, запуская команды, например для получения справки CLI.
• 03Проверяет относительные и внешние ссылки; правила пропуска настраиваются, а для проверки ссылок учитываются возможности GitHub.
• 04Заменяет ссылки на относительные пути для сайтов с несколькими доменами или версиями.
• 05Преобразует Markdown: добавляет front matter и back matter, перемещает файлы для генераторов статических сайтов.

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

• Поддерживать в актуальном состоянии справку CLI и примеры конфигурации в README репозитория с помощью CI.
• Находить неработающие ссылки в документации при проверке pull request.
• Публиковать версионную документацию проекта из Markdown-файлов на статическом сайте.

Быстрый старт

1. 1

   Установите CLI mdox с помощью Go

2. 2

   Отформатируйте файлы Markdown с помощью mdox fmt

   mdox fmt *.md

Что важно знать

• !В README нет явной команды go install, поэтому шаг установки не приводится в виде команды.
• !Проект небольшой — у него 80 звёзд, поэтому поддержка сообщества может быть ограниченной.

В подборках

Темы

Частые вопросы

Что такое mdox?

CLI на Go для форматирования Markdown в стиле GFM, генерации фрагментов кода из команд, проверки ссылок и сборки статических сайтов из Markdown. mdox — инструмент командной строки, который помогает поддерживать документацию проекта точной и единообразной. Он форматирует Markdown-файлы на месте по правилам GitHub Flavored Markdown и проверяет относительные и внешние ссылки. Можно настроить исключения для отдельных URL, а ссылки на issues и pull requests в GitHub проверять через GitHub API.

mdox можно использовать бесплатно? Какая у него лицензия?

mdox распространяется с открытым исходным кодом под лицензией Apache-2.0. Перед использованием в коммерческих продуктах проверьте условия лицензии.

mdox всё ещё поддерживается?

Активно поддерживается. Последний коммит в mdox — 3 нояб. 2026 г..

Для чего можно использовать mdox?

Поддерживать в актуальном состоянии справку CLI и примеры конфигурации в README репозитория с помощью CI. Находить неработающие ссылки в документации при проверке pull request. Публиковать версионную документацию проекта из Markdown-файлов на статическом сайте.

Как установить mdox?

Установите CLI mdox с помощью Go Отформатируйте файлы Markdown с помощью mdox fmt: mdox fmt *.md

Где скачать mdox?

Исходный код и инструкции по установке — на GitHub: https://github.com/bwplotka/mdox