Doctave

Doctave — это платформа для документации, которая сочетает гибкость написания в Markdown с мощью профессионального хостинга документации. Вы пишете свою документацию в простых текстовых файлах, храните их в Git вместе с вашим кодом, а Doctave превращает их в красивые, удобные для поиска веб-сайты документации.

Платформа поддерживает как обычные руководства на Markdown, так и спецификации OpenAPI для документации API. Она автоматически создает предварительные среды при внесении изменений, чтобы ваша команда могла просмотреть обновления перед публикацией. Всё хранится в вашем репозитории Git, обеспечивая полный контроль версий вашей документации.

Doctave Studio — это сопутствующее настольное приложение, которое предоставляет предварительный просмотр в реальном времени, автозаполнение, проверку битых ссылок и орфографии. Вместе эти инструменты помогают командам создавать документацию, которая остается актуальной и точной.

Начать работу с Doctave просто. Вот как эффективно его использовать:

• Создайте папку с документацией в вашем репозитории кода и пишите содержимое с помощью файлов Markdown. Включите файл README.md в качестве стартовой страницы.

• Установите Doctave Studio на свой компьютер, чтобы просматривать документацию локально с обновлениями в реальном времени по мере написания.

• Настройте файл конфигурации doctave.yml, чтобы определить структуру документации, цвета темы и навигационные ссылки.

• Подключите ваш Git-репозиторий к Doctave через их платформу. Каждый раз при отправке изменений Doctave автоматически обновляет опубликованную документацию.

• Для документации API добавьте файл спецификации OpenAPI в ваш репозиторий. Doctave автоматически сгенерирует интерактивные страницы справочника API.

• Используйте ветки Git для управления разными версиями документации. Создавайте pull-запросы для проверки изменений перед публикацией, и Doctave сгенерирует ссылки для предварительного просмотра каждого pull-запроса.

• Рабочий процесс документации на основе Git с управлением версиями

• Настольный редактор Doctave Studio с предварительным просмотром в реальном времени

• Поддержка спецификации OpenAPI для документации API

• Автоматические среды предварительного просмотра для pull-запросов

• Управление документацией нескольких версий

• Встроенный поиск по всему содержимому

• Настраиваемый брендинг и темы

• Аналитика читателей и сбор отзывов

• Интеграция CI/CD для автоматического развертывания

• Опции документации с защитой паролем