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!
Getting Started
Usage
Configuration
Configure the `doom` documentation tool
- Configuration File
- Basic Configuration
- API Documentation Configuration
- Permission Documentation Configuration
- Reference Documentation Configuration
- Release Notes Configuration
- Sidebar Configuration
- Internal Documentation Routes Configuration
- Only Include Documentation Routes Configuration
- Syntax Highlighting Plugin Configuration
sites.yamlConfiguration- Translation Configuration
- Editing Documentation in Code Repository
- Documentation Export Configuration
- Documentation Lint Configuration
- Algolia Search Configuration
- Sitemap 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
Using MDX enables dynamic content display and content reuse
Deployment
After the documentation project development is completed, we can deploy the project to the ACP platform