logo
Doom
English
简体中文
English
简体中文
logo
Doom
基本介绍
开始

使用

配置
约定
Markdown
MDX
国际化
API 文档
权限说明文档
引用文档
部署

APIs

高级 API

Event APIs

Search

Log APIs

Aggregation
Search
CodeQualityTaskSummary
Projects

CRDs

ArtifactCleanupRun

公共引用

CodeQuality
CodeQualityBranch

#使用

配置

配置 `doom` 文档工具
  • 配置文件
  • 基础配置
  • API 文档配置
  • 权限说明文档配置
  • 引用文档配置
  • 发行说明配置
  • 左导航配置
  • 内部文档路由配置
  • 仅包含文档路由配置
  • 语言高亮插件配置
  • sites.yaml 配置
  • 翻译配置
  • 在代码仓库编辑文档
  • 文档检查配置
  • Algolia 搜索配置
  • Sitemap 配置

约定

基于“约定大于配置”的理念,我们约定文档的组织方式以自动生成左侧边栏等相关内容
  • 目录结构
  • 元数据
  • 排序
  • 预览

Markdown

  • Callouts
  • Mermaid

MDX

使用 MDX 可以实现动态内容的展示和内容复用
  • rspress 组件
  • doom 组件
  • 自定义组件复用

国际化

在可复用组件中使用国际化文本
  • i18n.json
  • .ts/.tsx
  • .mdx

API 文档

  • 高级 API
  • CRD
  • 公共引用
  • 指定 openapi 路径

权限说明文档

  • props
  • 示例

引用文档

  • 引用文档配置

部署

文档项目开发完成后我们可以将项目部署到 ACP 平台
  • 构建与预览
  • 多版本构建
  • 合并目录结构
  • 动态挂载配置文件
📝 在 GitHub 上编辑此页
上一页开始
下一页配置