---
title: "注册表"
description: "nimbus-docs add 读取的条目目录，包括组件、工具、功能和内容来源。"
---

> Documentation Index
> Fetch the complete documentation index at: https://nimbus.ndjp.net/llms.txt
> Use this file to discover all available pages before exploring further.

# 注册表

注册表是 `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。
- **`registry:source`**——内容来源，用 `nimbus-docs add source <name>` 添加。一份给智能体的指南，由它把来源所需的代码写入你的站点。示例：`github`、`notion`。

## 条目结构

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

- **`type`**——`registry:ui`、`registry:lib`、`registry:feature` 或 `registry:source`。
- **`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`——端到端接入新的文档版本，并带版本切换器。

## 来源

来源从 `src/content` 以外的地方构建站点的一部分。用 `npx @cloudflare/nimbus-docs add source <name|url>` 添加：

- `git`（也包括 `github`、`gitlab`、`bitbucket`）——来自另一个 git 仓库的页面，在构建时检出。
- `notion`——来自 Notion 数据库的页面；智能体根据指南编写 `src/loaders/notion.ts`。
- 一个 URL——一份指南，教你根据任何其他提供商的文档编写 loader。

参见[来自其他来源的内容](/content-sources/git/)。

## 内容配方

用于编写某一形态的单页的模板——智能体搭好结构，由你填充内容。命令相同：`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`——带日期、分类并标记破坏性变更的记录。

Source: https://nimbus.ndjp.net/registry/index.mdx