blocks: - type: header-block width: s offset: default title: How does it all work? resetPaddings: true verticalOffset: l description: |- 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. background: light: image: desktop: 'https://storage.yandexcloud.net/diplodoc-www-assets/pages/how-to-diplodoc/ddos-how-cover.png' mobile: 'https://storage.yandexcloud.net/diplodoc-www-assets/pages/how-to-diplodoc/ddos-how-cover-mini.png' disableCompress: true color: '#C6FE4D' fullWidth: false dark: image: desktop: 'https://storage.yandexcloud.net/diplodoc-www-assets/pages/how-to-diplodoc/ddos-how-cover-dark.png' mobile: 'https://storage.yandexcloud.net/diplodoc-www-assets/pages/how-to-diplodoc/ddos-how-cover-mini.png' disableCompress: true color: '#C6FE4D' fullWidth: false - type: extended-features-block title: text: Docs as Code approach colSizes: all: 12 xl: 3 md: 4 sm: 6 items: - title: Markdown icon: 'https://storage.yandexcloud.net/cloud-www-assets/pages/how-to-diplodoc/how-to-diplodoc-01.svg' text: Documentation is written in the Markdown markup language rather than in plain text or a WYSIWYG editor. - title: Storage in a repository icon: 'https://storage.yandexcloud.net/cloud-www-assets/pages/how-to-diplodoc/how-to-diplodoc-02.svg' text: Documentation is stored in a repository along with the rest of the code. This can be GitHub or your own solution. - title: Streamlined process icon: 'https://storage.yandexcloud.net/cloud-www-assets/pages/how-to-diplodoc/how-to-diplodoc-03.svg' text: Documentation is built into the final project using a static site generator and published automatically. - title: Synchronization icon: 'https://storage.yandexcloud.net/cloud-www-assets/pages/how-to-diplodoc/how-to-diplodoc-04.svg' text: Documentation is written and updated collaboratively — just like the rest of the code. - type: card-layout-block title: Data storage children: - type: layout-item content: title: Добавление text: Исходный код документации хранится в репозитории клиента в формате Markdown. media: image: 'https://storage.yandexcloud.net/diplodoc-www-assets/pages/how-to-diplodoc/ddos-how-item-02-01.png' - type: layout-item content: title: Преобразование text: Преобразованный из Markdown-файлов документационный проект попадает в отдельную директорию S3-совместимого хранилища для каждого клиента. media: image: 'https://storage.yandexcloud.net/diplodoc-www-assets/pages/how-to-diplodoc/ddos-how-item-02-02.png' - type: layout-item content: title: Доступ text: Доступ к S3 регулируется с помощью уникальных ключей. media: image: 'https://storage.yandexcloud.net/diplodoc-www-assets/pages/how-to-diplodoc/ddos-how-item-02-03.png' - type: card-layout-block title: Deployment colSizes: all: 12 xl: 3 md: 4 sm: 6 children: - type: layout-item content: title: Хранение text: Документационный проект из S3-совместимого хранилища выкладывается на Diplodoc.com. media: image: 'https://storage.yandexcloud.net/diplodoc-www-assets/pages/how-to-diplodoc/ddos-how-item-03-01.png' - type: layout-item content: title: Проксирование text: Возможно проксирование с сайта клиента на сайт diplodoc.com для бесшовной интеграции. media: image: 'https://storage.yandexcloud.net/diplodoc-www-assets/pages/how-to-diplodoc/ddos-how-item-03-02.png' - type: layout-item content: title: Поиск text: Поддержка поиска с помощью Elasticsearch. media: image: 'https://storage.yandexcloud.net/diplodoc-www-assets/pages/how-to-diplodoc/ddos-how-item-03-03.png' - type: layout-item content: title: Локализация text: Поддержка локализации и кастомизации проекта документации. media: image: 'https://storage.yandexcloud.net/diplodoc-www-assets/pages/how-to-diplodoc/ddos-how-item-03-04.png' - type: card-layout-block title: Full compatibility children: - type: background-card title: YFM text: 'A Markdown dialect that conforms to the CommonMark specification, with plugin support and additional markup capabilities.' background: src: 'https://storage.yandexcloud.net/diplodoc-www-assets/pages/how-to-diplodoc/ddos-how-card-01.png' disableCompress: true paddingBottom: m border: none theme: light - type: background-card title: GitHub text: 'Full integration with version control systems, primarily GitHub — one of the main development tools.' background: src: 'https://storage.yandexcloud.net/diplodoc-www-assets/pages/how-to-diplodoc/ddos-how-card-02.png' disableCompress: true paddingBottom: m border: none theme: light - type: background-card title: Elasticsearch text: Fast indexing and search based on Elasticsearch to ensure the relevance and accuracy of query results. background: src: 'https://storage.yandexcloud.net/diplodoc-www-assets/pages/how-to-diplodoc/ddos-how-card-03.png' disableCompress: true paddingBottom: m border: none theme: light - type: icons-block size: m title: Join the community items: - src: 'https://storage.yandexcloud.net/cloud-www-assets/pages/index-diplodoc/github.svg' text: GitHub url: 'https://github.com/diplodoc-platform' - src: 'https://storage.yandexcloud.net/cloud-www-assets/pages/index-diplodoc/telegram.svg' text: Telegram url: 'https://t.me/diplodoc_ru' - src: 'https://storage.yandexcloud.net/cloud-www-assets/pages/index-diplodoc/stackoverflow.svg' text: Stack Overflow url: 'https://stackoverflow.com/tags/diplodoc' links: []