注册表

注册表是 nimbus-docs add 读取的数据源。有三种类型的条目——组件和工具以文件形式复制；功能则将配方交给智能体处理。

三种类型

• registry:ui — UI 组件。复制到 src/components/ui/<slug>/。例如：Badge、Card、Steps。
• registry:lib — 独立工具。复制到指定路径。例如：cn → src/lib/cn.ts。
• registry:feature — 智能体交接配方。不会复制文件；CLI 输出一段 markdown，由智能体读取后适配你的项目并应用。例如：404-page。

条目结构

badge: {
  type: "registry:ui",
  title: "Badge",
  description: "Small status / category pill.",
  registryDependencies: ["cn"],
},

• type — registry:ui、registry:lib 或 registry:feature。
• registryDependencies — CLI 必须先安装的其他 slug。会传递性地遍历依赖。
• dependencies — 添加到 package.json 的 npm 包。

安装依赖图

当你运行 npx @cloudflare/nimbus-docs add accordion 时，CLI 会遍历该 slug 的依赖图：

accordion
├── collapsible
└── cn

它会在安装 accordion 之前先安装 collapsible 和 cn。每个组件安装到清单中声明的路径。重复项会被跳过。

功能没有安装依赖图——配方是自包含的 markdown，智能体会在你现有的布局中应用它。

功能

功能是智能体交接配方——不会以文件形式复制任何内容。使用 npx @cloudflare/nimbus-docs add <slug> 安装任意功能；CLI 会输出一段摘要，由你的编码智能体适配项目后应用。

• pagefind-search — 静态全文搜索和 Nimbus 搜索对话框。
• ai-native — llms.txt 索引、替代 Markdown/MDX 版本、robots.txt 和 AgentDirective。
• mermaid — 延迟加载、主题感知的 Mermaid 图表，支持全屏展开。
• 404-page — 与品牌风格匹配的文档 404 页面。
• lint-prose-textlint — 带有 write-good、alex 和术语规则的 textlint。
• changelog — 带标签、RSS 和永久链接的日期化 /changelog 动态。
• component-showcase — UI 组件的 /components 网格和每个组件的单独页面。
• new-collection — 非版本化的内容树：博客、API 或术语表。
• api-reference — 将 OpenAPI 规范挂载为生成的参考页面，带替代 Markdown 版本，使用自有 api-layout / api-sidebar / api-field-row / api-code-rail 组件进行样式设置。
• new-version — 端到端连接新文档版本，带版本切换器。

内容配方

用于撰写特定结构页面的模板——智能体为你搭建结构，你来填充内容。使用相同命令：npx @cloudflare/nimbus-docs add <slug>。

• content-overview — 用一段话概括，然后引导读者继续阅读。
• content-quickstart — 通往一个可用结果的最短路径。
• content-tutorial — 分步骤构建一个真实项目。
• content-how-to — 从目标到验证结果的分步指南。
• content-concept — 解释某个概念是什么、为什么重要以及边界在哪里。
• content-reference — 完整、中立、模板化的查询页面。
• content-example — 可直接复制运行的代码，必要时附带说明。
• content-troubleshooting — 按搜索词组织的症状、原因和修复方法。
• content-changelog — 带日期、分类的变更记录，标注破坏性变更。