Introduction
Doom is a documentation development tool designed for internal use at Alauda, built on top of rspress. It provides users with a rich set of built-in plugins for an out-of-the-box experience.
TOC
Core Capabilities
- Automatically generates a configurable weight (order) left sidebar
- Full-text static document search
- Multilingual support
Based on Markdown and its extension MDX
MDX is a powerful content development approach. You can write Markdown files as you normally would while also using React components within the Markdown content:
For more details, you can refer to the “Using MDX” documentation.
Get Started
Let's get started quickly with Doom!
Start
Usage
Configuration
Configure `doom` documentation tool
- Configuration File
- Basic Configuration
- API Documentation Configuration
- Permission Explanation Document Configuration
- Reference Document Configuration
- Release Notes Configuration
- Left Navigation Configuration
- Internal Document Routes Configuration
- Only Include Document Routes Configuration
- Language Highlight Plugin Configuration
sites.yamlConfiguration- Translation Configuration
- Edit Documentation in Code Repository
- Document Linting Configuration
Convention
Based on the principle of "convention over configuration", we agree on the organization of documents to automatically generate the left sidebar and related content.
MDX
Dynamic content display and content reuse can be achieved using MDX
Deployment
After completing the project development, we can deploy the project to the ACP platform.