安装 | Nimbus 中文文档

一条命令即可搭建一个项目，包含布局、组件、内容模式、搜索、站点地图、OG 图片，以及每个页面的 Markdown 版本。

环境要求

Node 22.12 或更高版本
包管理器 — npm、pnpm、yarn 或 bun
Git — 用于编辑链接和最后更新日期

创建项目

npx @cloudflare/create-nimbus-docs@latest

输入目录名称，然后选择你的偏好：

模板

两个选项 — full（核心组件、示例内容、已填充的主题 token）或 empty（运行所需的最小配置，准备好接收你自己的内容）。

输出模式

Static 会预渲染每个内容集合路由，可部署到任何地方。Server 使用 Cloudflare 按需渲染这些路由。你稍后可以覆盖单个集合的设置。

目标平台

静态输出支持 Cloudflare 或其他静态托管服务。交互式服务端设置目前提供 Cloudflare Workers；显式的 --adapter 标志也支持 Vercel、Netlify 和 Node。

安装依赖

脚手架工具会自动运行你的包管理器。如果你想先编辑 package.json，可以跳过此步骤。

项目结构

my-docs/
- src/
  - components/
    - ui/
  - content/
    - docs/
  - pages/
  - styles/
    - globals.css
  - components.ts
- astro.config.ts
- package.json

nimbus-docs npm 包提供底层基础设施（集成、数据辅助函数、模式定义）。所有可见的部分 — src/components/ 下的组件、src/content/docs/ 下的 MDX 内容、src/pages/ 下的路由、src/styles/globals.css 中的设计 token，以及 src/components.ts 中的 MDX 全局注册表 — 都会复制到你的仓库中，供你自由编辑。

运行

npm run dev

yarn run dev

pnpm run dev

bun run dev

然后打开输出的 URL。

构建和部署

npm run build

yarn run build

pnpm run build

bun run build

静态脚手架会生成 dist/ 目录，可部署到任何静态托管服务。Cloudflare 服务端脚手架会按需渲染规范的内容集合路由，并包含相应的 wrangler.jsonc 和 deploy 脚本。