logo
Doom
English
简体中文
English
简体中文
logo
Doom
Introduction
Getting Started

Usage

Configuration
Convention
Markdown
MDX
Internationalization
API Documentation
Permission Description Document
Referencing Documents
Deployment

APIs

Advanced API

Event APIs

Search

Log APIs

Aggregation
Search
CodeQualityTaskSummary
Projects

CRDs

ArtifactCleanupRun

Public References

CodeQuality
CodeQualityBranch

#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.yaml Configuration
  • 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.
  • Directory Structure
  • Metadata
  • Sorting
  • Preview

Markdown

  • Callouts
  • Mermaid
  • Attribute Extensions

MDX

Using MDX enables dynamic content display and content reuse
  • rspress Components
  • doom Components
  • Custom Component Reuse

Internationalization

Using Internationalized Text in Reusable Components
  • i18n.json
  • .ts/.tsx
  • .mdx

API Documentation

  • Advanced APIs
  • CRD
  • Common References
  • Specifying OpenAPI Path

Permission Description Document

  • props
  • Example

Referencing Documents

  • Document Reference Configuration

Deployment

After the documentation project development is completed, we can deploy the project to the ACP platform
  • Build and Preview
  • Multi-version Build
  • Merged Directory Structure
  • Dynamic Mount Configuration File
📝 Edit this page on GitHub
Previous PageGetting Started
Next PageConfiguration