MdDocs

Создай документацию для своего проекта с Markdown и Swagger.

MdDocs — это быстрый, простой и совершенно великолепный генератор статических сайтов, предназначенный для создания документации о вашем проекте или услуги. Исходные файлы документации записываются в формате Markdown и настраиваются с помощью одного файла конфигурации YAML. Начните с прочтения вводного руководства, а затем обратитесь к Руководству пользователя для получения дополнительной информации.

• Начать
• Руководство пользователя
• Дорожная карта

Возможности

Уникальный дизайн вашей темы

Для MdDocs доступно множество красивых тем. Выберите между встроенными темами: mkdocs и readthedocs, выберите одну из сторонних тем, перечисленных на вики-странице тем MdDocs, или создайте свою собственную тему.

Легко настроить

Чтобы документация вашего проекта выглядела именно так, как вы хотите, настройте тему и/или установите некоторые плагины. Измените отображение разметки Markdown с помощью расширений Markdown. Доступно множество вариантов конфигурации.

Хостинг в любом месте

MdDocs создает полностью статические HTML-сайты, которые вы можете разместить на страницах GitHub, Amazon S3 или в любом другом месте по вашему выбору.

Предварительный просмотр вашего сайта во время работы

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