logo
Doom
English
简体中文
English
简体中文
logo
Doom
Introduction
Start

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

Markdown

  • Callouts
  • Mermaid

MDX

Dynamic content display and content reuse can be achieved using MDX
  • 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 completing the project development, we can deploy the project to the ACP platform.
  • Build and Preview
  • Multi-Version Builds
  • Merged Directory Structure
  • Dynamic Mounting Configuration File
📝 Edit this page on GitHub
Previous PageStart
Next PageConfiguration