How does it work?

Diplodoc is a documentation platform that includes the following components:

  • Client component: displays documents in the user’s browser.
  • Server component: hosting and delivering documents to the client.
  • Tools for creating and converting Markdown documents to static sites (Transform & Build).

The system runs basic operations in Node.js and React.

Docs as Code Concept

Markdown

Instead of plain text or a WYSIWYG editor, documentation is written in the Markdown markup language.

Repository Storage

Documentation is stored in the same repository as the rest of the code. It can be either GitHub or your own solution.

Streamlined Process

Documentation is compiled into a final project using a static site generator and is published automatically.

Synchronization

Documentation is written and updated collaboratively, just like the rest of the code.

Data Storage

Addition

Documentation source code is stored in Markdown format in the client repository.

Conversion

The documentation project generated from Markdown files is saved in an S3-compatible storage directory that is kept separate for each client.

Access

Access to S3 is managed with the help of unique keys.

Deployment

Storage

The documentation project from the S3 storage is published on Diplodoc.com.

Proxying

For seamless integration, it is possible to proxy from the client’s website to diplodoc.com.

Search

Search support with Elasticsearch.

Localization

Support for localization and customization of project documentation.

Full Compatibility

YFM

A CommonMark-compliant Markdown dialect, with plugin support and additional markup features.

GitHub

Full integration with version control systems, especially GitHub, one of the most popular development tools.

Elasticsearch

The fast indexing and search capabilities of Elasticsearch ensure accurate and relevant query results.