Docs as Code Concept
Instead of plain text or a WYSIWYG editor, documentation is written in the Markdown markup language.
Documentation is stored in the same repository as the rest of the code. It can be either GitHub or your own solution.
Documentation is compiled into a final project using a static site generator and is published automatically.
Documentation is written and updated collaboratively, just like the rest of the code.
Documentation source code is stored in Markdown format in the client repository.
The documentation project generated from Markdown files is saved in an S3-compatible storage directory that is kept separate for each client.
Access to S3 is managed with the help of unique keys.
The documentation project from the S3 storage is published on Diplodoc.com.
For seamless integration, it is possible to proxy from the client’s website to diplodoc.com.
Search support with Elasticsearch.
Support for localization and customization of project documentation.
A CommonMark-compliant Markdown dialect, with plugin support and additional markup features.
Full integration with version control systems, especially GitHub, one of the most popular development tools.
The fast indexing and search capabilities of Elasticsearch ensure accurate and relevant query results.