Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Diplodoc - documentation platform in "docs as code" paradigm. #968

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions src/site/generators/diplodoc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
title: Diplodoc
repo: diplodoc-platform
homepage: https://diplodoc.com/en/
language:
- JavaScript, Node.js
license:
- MIT
templates:
- Markdown
description: 'A platform for creating technical documentation based on the concept of Docs as Code.'
startertemplaterepo: https://github.com/diplodoc-platform/documentation-template
---


## Ease of Use

Manage documents as if they were source code: in a familiar environment with minimal deployment and maintenance effort.

## Flavored Markdown

Use enhanced markdown with necessary documentation components like code blocks, images, diagrams, and more.

## Combine handwritten and generated documentation

Сreate comprehensive documents manually while also integrating automatically generated content from OpenAPI (formerly Swagger) definitions.

## Ready for Translations

The platform natively supports text extraction for various translation systems such as SmartCAT, Weblate, YaCAT, and Yandex Translate.

## Single source publishing

Use advantage of single source publishing, enabling the creation of multiple similar document versions from a single source text for consistent and efficient content management.

## Page Constructor

The platform natively supports [Page Constructor](https://github.com/gravity-ui/page-constructor), allowing users to enhance individual documentation pages with carousels, backgrounds, smoothly animated cards, and various other blocks, as well as create landing pages. 

## Right-to-Left

Diplodoc offers the advantage of supporting Right-to-Left (RTL) mode, ensuring seamless access and readability for languages such as Arabic and Hebrew.

## Integrated Search Functionality

The most typical use case for document searching on the platform, without extra costs or support efforts.