Diplodoc

Платформа для создания технической документации в концепции Docs as Сode с открытым исходным кодом. Простое и удобное решение для развёртывания документации больших и маленьких команд.

Начать GitHub

Простота использования

Работа с документами как с кодом: в привычной среде и с минимальными усилиями по развёртыванию и поддержке.

Скорость работы

Быстрая сборка, валидация и выкладка документации любого размера. Полная интеграция в существующие CI/CD-системы для ускорения работы.

Общепринятый формат Markdown

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

Обширная функциональность

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

Интеграция с системами автоматической документации

Поддержка широко распространённой OpenAPI-спецификации «из коробки». Обеспечение работы специализированных систем через интерфейс подключаемых внешних документов.

Интегрированный поиск

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

Инструменты для работы с документацией

Плагин для Visual Studio Code

Создавайте и редактируйте документацию прямо в Visual Studio Code. Визуальный редактор Markdown, оглавления и лендингов, автодополнение, проверка ошибок и навигация по ссылкам.

Установить плагин

Исходный код на GitHub

Помощь AI-ассистентам

Документация Diplodoc в Context7 и готовые скиллы помогают AI-ассистентам писать YFM-разметку, настраивать проекты и разбираться в ошибках сборки.

Diplodoc в Context7

Скиллы на GitHub

Документация для AI

Генерация llms.txt, sitemap.xml и Markdown-версий страниц помогает AI-ассистентам находить и читать документацию. Нужный текст можно просмотреть и скопировать в Markdown для передачи ассистенту.

Генерация llms.txt

Extensions API

Создавайте расширения для Diplodoc CLI: добавляйте обработку и проверку документов, настраивайте оглавление и подключайте внешние сервисы.

Разработка расширений

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

Архитектура

Платформа Diplodoc имеет клиент-серверную архитектуру: серверная часть состоит из компонентов на Node.js, которые генерируют и отображают документационные проекты. Такая архитектура обеспечивает надёжность и горизонтальное масштабирование в случае необходимости.

Интеграция с GitHub

Платформа Diplodoc имеет сквозную интеграцию с GitHub для обеспечения простого и стабильного механизма сборки и развёртывания документационных проектов. GitHub используется как хранилище исходного кода для документов и исполнения пайплайна проекта.

Развёртывание

Компании — пользователи сервиса Diplodoc используют встроенные механизмы выкладки документационного проекта с последующей их индексацией и отслеживанием версий. Документы могут обновляться как в автоматическом, так и в полуавтоматическом режиме с привлечением администратора со стороны пользователя.