From 8857f035d65cf515d1519d498d51c01a523f292d Mon Sep 17 00:00:00 2001 From: Yury Puzynya <3y3@ya.ru> Date: Fri, 5 Jul 2024 15:42:03 +0300 Subject: [PATCH 1/2] Create diplodoc.md --- src/site/generators/diplodoc.md | 46 +++++++++++++++++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 src/site/generators/diplodoc.md diff --git a/src/site/generators/diplodoc.md b/src/site/generators/diplodoc.md new file mode 100644 index 00000000..da985091 --- /dev/null +++ b/src/site/generators/diplodoc.md @@ -0,0 +1,46 @@ +--- +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. From fdaacebc85682aa3bab071e2fe92be45fadc7c8a Mon Sep 17 00:00:00 2001 From: Yury Puzynya <3y3@ya.ru> Date: Fri, 5 Jul 2024 15:55:10 +0300 Subject: [PATCH 2/2] Update diplodoc.md --- src/site/generators/diplodoc.md | 1 + 1 file changed, 1 insertion(+) diff --git a/src/site/generators/diplodoc.md b/src/site/generators/diplodoc.md index da985091..0beb49c5 100644 --- a/src/site/generators/diplodoc.md +++ b/src/site/generators/diplodoc.md @@ -44,3 +44,4 @@ Diplodoc offers the advantage of supporting Right-to-Left (RTL) mode, ensuring ## Integrated Search Functionality The most typical use case for document searching on the platform, without extra costs or support efforts. +