https://github.com/diplodoc-platform/diplodoc

Entrypoint to Diplodoc platform
https://github.com/diplodoc-platform/diplodoc

overview quick-start

Last synced: 2 days ago
JSON representation

Entrypoint to Diplodoc platform

• Host: GitHub
• URL: https://github.com/diplodoc-platform/diplodoc
• Owner: diplodoc-platform
• License: mit
• Created: 2023-09-27T10:36:47.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-12-14T19:21:38.000Z (16 days ago)
• Last Synced: 2024-12-21T13:05:56.205Z (9 days ago)
• Topics: overview, quick-start
• Language: JavaScript
• Homepage:
• Size: 2.34 MB
• Stars: 200
• Watchers: 3
• Forks: 13
• Open Issues: 28
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Roadmap: ROADMAP.md

Awesome Lists containing this project

README

        
![logo](.github/assets/diplodoc-logo.svg#gh-light-mode-only)

![logo](.github/assets/diplodoc-logo-dark.svg#gh-dark-mode-only)

---

  [Website](https://diplodoc.com)   |

  [Documentation](https://diplodoc.com/docs)   |

  [Telegram](https://t.me/diplodoc_ru)

---

Diplodoc Platform is open platform for work with your documentation in accordance with "Documentation as a Code" paradigm.

Simple and comfortable solution for everyone.

## Advantages of the platform

### 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

Create comprehensive documents manually while also integrating automatically generated content from OpenAPI (formerly Swagger) definitions. Custom includer’s interface allows creation of any kind of autogenerated docs (JavaDoc, etc..)

### 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.

## Getting Started

Try Diplodoc [locally or with your development pipelines](https://diplodoc.com/docs/ru/how-it-work) or try within [codespace](https://github.com/codespaces/new?repo=688437532) online.

## Contribution