How does it all work?
How does it all work?
Diplodoc is a documentation platform with the following components:
- the client side is responsible for displaying documents in the browser on the user's side;
- the server side is responsible for hosting and delivering documents to the client;
- tools for creating and converting documents from Markdown into a static site (Transform & Build).
The system performs core operations on Node.js and React.
Docs as Code approach
Markdown
Documentation is written in the Markdown markup language rather than in plain text or a WYSIWYG editor.
Storage in a repository
Documentation is stored in a repository along with the rest of the code. This can be GitHub or your own solution.
Streamlined process
Documentation is built into the final project using a static site generator and published automatically.
Synchronization
Documentation is written and updated collaboratively — just like the rest of the code.
Data storage
Добавление
Исходный код документации хранится в репозитории клиента в формате Markdown.
Преобразование
Преобразованный из Markdown-файлов документационный проект попадает в отдельную директорию S3-совместимого хранилища для каждого клиента.
Доступ
Доступ к S3 регулируется с помощью уникальных ключей.
Deployment
Хранение
Документационный проект из S3-совместимого хранилища выкладывается на Diplodoc.com.
Проксирование
Возможно проксирование с сайта клиента на сайт diplodoc.com для бесшовной интеграции.
Поиск
Поддержка поиска с помощью Elasticsearch.
Локализация
Поддержка локализации и кастомизации проекта документации.
Full compatibility
YFM
A Markdown dialect that conforms to the CommonMark specification, with plugin support and additional markup capabilities.
GitHub
Full integration with version control systems, primarily GitHub — one of the main development tools.
Elasticsearch
Fast indexing and search based on Elasticsearch to ensure the relevance and accuracy of query results.
