Diplodoc
Diplodoc
An open-source platform for creating technical documentation using the Docs as Code concept. A simple and convenient solution for deploying documentation for large and small teams.
Platform advantages
Ease of use
Work with documents as code: in a familiar environment and with minimal effort for deployment and maintenance.
Performance
Fast build, validation, and publishing of documentation of any size. Full integration into existing CI/CD systems to speed up workflows.
Common Markdown format
Simple, clear, and widely used syntax with support for basic Markdown. Focus on content, not on how to deliver it to the user.
Extensive functionality
Creation of documents of any complexity, including generation from a single source and work with variables. Extensive customization and display options ensure end-user satisfaction.
Integration with automated documentation systems
Support for the widely used OpenAPI specification out of the box. Enabling specialized systems through an interface for pluggable external documents.
Integrated search
The most common user scenario for searching documents on the platform without additional costs or maintenance efforts.
How does it work?
Архитектура
Платформа Diplodoc имеет клиент-серверную архитектуру: серверная часть состоит из компонентов на Node.js, которые генерируют и отображают документационные проекты. Такая архитектура обеспечивает надёжность и горизонтальное масштабирование в случае необходимости.
Интеграция с GitHub
Платформа Diplodoc имеет сквозную интеграцию с GitHub для обеспечения простого и стабильного механизма сборки и развёртывания документационных проектов. GitHub используется как хранилище исходного кода для документов и исполнения пайплайна проекта.
Развёртывание
Компании – пользователи сервиса Diplodoc используют встроенные механизмы выкладки документационного проекта с последующей их индексацией и отслеживанием версий. Документы могут обновляться как в автоматическом, так и в полуавтоматическом режиме с привлечением администратора со стороны пользователя.
How to try Diplodoc
Discuss a pilot project
Tell us about your project and requirements — the Diplodoc team will help you create documentation.
Try it yourself
Create and publish a documentation project for your product.
View the project on GitHub
We have released the source code of our platform as open source. You can help us improve.
