# @cloudflare/nimbus-docs 中文文档

规范地址：https://npmcn.com/package/%40cloudflare/nimbus-docs/

版本：0\.19\.4
npm 元数据更新时间：2026-11-06T14:48:19.467Z
中文译文更新时间：2026-11-10T03:07:58.699Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40cloudflare/nimbus-docs
原文对照：https://npmcn.com/package/%40cloudflare/nimbus-docs/?lang=original
项目主页：https://nimbus-docs.com/
源码仓库：https://github.com/cloudflare/nimbus

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：7.3 MB，310 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=22\.12\.0
- 运行依赖：45 个
- peer 依赖：astro \>=7\.2\.6 \<8\.0\.0，react \>=19\.0\.0，satori \>=0\.26\.0 \<0\.27\.0，react-dom \>=19\.0\.0，@resvg/resvg-js \>=2\.6\.2 \<3\.0\.0，openapi-sampler \>=1\.5\.0，@readme/httpsnippet \>=10\.0\.0，@scalar/openapi-parser \>=0\.10\.0 \<1\.0\.0，@modelcontextprotocol/server \>=2\.3\.0 \<3\.0\.0
- 首次发布：2026-07-16T20:59:03.377Z
- 最新版本发布：2026-11-06T14:48:18.902Z
- 近 30 天下载量：194822（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：29（近 12 个月 29 个）

## 中文简介

人类和特工的医生

## 安装

```sh
npm install @cloudflare/nimbus-docs
```

也可以使用：`pnpm add @cloudflare/nimbus-docs`、`yarn add @cloudflare/nimbus-docs`、`bun add @cloudflare/nimbus-docs`

## README

# @cloudflare/nimbus-docs (英语)

Astro一体化和CLI促进 [烟花](https://nimbus-docs.com/),用于编写文件的工具.

与脚手架创建站点, 安装和配置此软件包 :

```sh
npx @cloudflare/create-nimbus-docs@latest my-docs
```

## 一体化

新站点呼叫 `nimbus(config)` 内 `astro.config.ts`。集成过程为 MDX, 验证构建过程中的配置和内容, 索引搜索, 并为帮助者提供您的路由调用 。 脚手架将内容集、路线、布局和UI组件复制到您的Repo中。 共享组件,如 `NimbusHead` 财务报告和审定财务报表 `Icon` 来自这个包裹.

## 国家行动倡议

在站点内运行命令 `npx nimbus-docs <command>`。 。 。 .

### 添加到您的网站

`add` 复制组件及其作为源代码的依赖性。 特征是Markdown食谱:运行命令的编码代理直接接收食谱,以及 `--print` 写出来给任何探员 或者让你跟随.

```sh
npx nimbus-docs add tabs
npx nimbus-docs add new-version --print
```

`add` 仅列出登记册. `add source github --print` 或者说 `add source notion --print` 从另一个寄存器或Notion打印用于加载页面的指南. `add adapter-<cloudflare|netlify|vercel|node>` 安装和配置服务器适配器.

### 检查您的页面

`check` 找到问题,没有建筑. `lint` 抓取写入错误; 首先建立网站, 因此它有链接地图 。 两个都拿 `--fix`。 。 。 . `check --json` 财务报告和审定财务报表 `lint --format json` 给出一个特工的发现 它可以采取行动.

```sh
npx nimbus-docs check
npx nimbus-docs lint --fix
```

### 跟紧尼姆布斯

在更新复制到您的 repo 的启动文件之前, 审查上游更改 . `outdated` 列出后面的启动文件、组件和软件包更改. `diff <file>` 显示启动文件的上游变化,以及 `--apply` 当你没有编辑文件时就把它拿走. `migrate` 应用编辑新版本的需要并列出需要审查的版本.

```sh
npx nimbus-docs outdated
npx nimbus-docs migrate
```

以前创建的网站 `nimbus.json` 存在的起始 `npx nimbus-docs init`。 。 。 .

## 进口

| 导入 | 对于 |
| --- | --- |
| `@cloudflare/nimbus-docs` | `nimbus()` 财务报告和审定财务报表 `defineConfig` |
| `@cloudflare/nimbus-docs/runtime` | 路径中的页面数据:侧边栏、面包屑、上下行 |
| `@cloudflare/nimbus-docs/content` | 内容集 |
| `@cloudflare/nimbus-docs/client` | 您组件的浏览器行为 |
| `@cloudflare/nimbus-docs/react` | 无头交互式图表 |

这个 [软件包 API](https://nimbus-docs.com/styling/package-api) 覆盖您将使用最多的助手; TypeScript 声明列出每个导出项 .

## 文档

[nimbus-docs.com 页面存档备份,存于互联网档案馆](https://nimbus-docs.com/)时,在 [nimbus-docs.com/cli (英语)](https://nimbus-docs.com/cli)。 。 。 .

## 许可证

麻省理工学院

## 常见问题

### @cloudflare/nimbus-docs 是什么？

人类和特工的医生

### 如何安装 @cloudflare/nimbus-docs？

在项目目录运行 npm install @cloudflare/nimbus-docs，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：astro（\>=7\.2\.6 \<8\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。它还提供命令行工具 nimbus-docs，可以用 npx nimbus-docs 直接运行。

### @cloudflare/nimbus-docs 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @cloudflare/nimbus-docs 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @cloudflare/nimbus-docs 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22\.12\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @cloudflare/nimbus-docs 可以商用吗？

@cloudflare/nimbus-docs 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @cloudflare/nimbus-docs 的下载量有多少？

根据 npm 官方下载统计，@cloudflare/nimbus-docs 在 2026/10/10 – 2026/11/08 这 30 天内被下载 194,822 次，日均约 6,494 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @cloudflare/nimbus-docs 还在维护吗？

最新版本 0\.19\.4 发布于 2026/11/06（3 天前）；至今共发布 29 个版本，其中过去 12 个月发布了 29 个；首次发布于 2026/07/17。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。