cloudflare/nimbus

# Nimbus **掌控属于你的文档站点，让人类和智能体都成为一等公民。** Nimbus 会将一个完整的 Astro 文档站点脚手架生成到你的仓库中——包括布局、组件、样式、路由和内容——它们都是你从第一次提交开始就可以编辑的真实文件。那些底层的隐蔽基础工程以 npm 包的形式提供；你看到和塑造的一切都归你所有。 文档：[nimbus-docs.com](https://nimbus-docs.com) ## 快速开始 ``` npx @cloudflare/create-nimbus-docs@latest my-docs cd my-docs pnpm install pnpm dev ``` 打开输出的 URL，编辑 `src/` 下的任何内容，页面就会自动重新加载。现在你就拥有了一个完整的文档站点。 脚手架工具会询问几个问题（部署目标、包管理器、使用入门模板还是空白内容）。你可以使用 `--yes` 来跳过这些问题： ``` npx @cloudflare/create-nimbus-docs@latest my-docs --yes ``` 在交互式运行中，你可以为项目选择包管理器。如果使用了 `--yes`，它会默认使用 npm——你可以添加 `--package-manager pnpm`（或者 `yarn`/`bun`）来选择其他的包管理器。 ## 日常命令 在你的项目中运行以下命令： | 命令 | 作用 | | --- | --- | | `pnpm dev` | 带有热重载功能的开发服务器 | | `pnpm build` | 生成静态构建到 `dist/` 目录 | | `pnpm preview` | 预览构建生成的站点 | | `pnpm typecheck` | 类型检查 (`astro check`) | | `pnpm lint:docs` | 对正文和 MDX 进行 Lint（添加 `--fix` 可自动修复） | ## 部署 默认生成静态站点——`pnpm build` 会输出 `dist/` 目录，你可以将其托管在任何地方。 Cloudflare 是一等部署目标：默认的脚手架会附带 `wrangler.jsonc` 配置文件。 ``` pnpm build pnpm run deploy # wrangler deploy to Cloudflare ``` ## 按需添加 从 registry 中拉取可选的组件、实用工具以及 agent 交接功能——每一项都会作为你拥有的源码落入你的仓库中： ``` pnpm dlx @cloudflare/nimbus-docs add dialog pnpm dlx @cloudflare/nimbus-docs add 404-page ``` 组件和实用工具会作为可编辑的文件复制到项目中。功能模块会提供一份方案（recipe），供你的编程智能体（coding agent）读取，并使其适配你的项目然后加以应用。 ## 你将获得什么 - **完全归属的源码** —— 布局、组件、内容集合（content collections）、样式和主题 token，全部可编辑。 - **智能体交互面** —— 每个页面都拥有对应的 `.md` / `.mdx` 双胞胎文件，提供 `/llms.txt` + `/llms-full.txt`、JSON-LD、站点地图、`robots.txt` 以及逐页的 OG 图像。默认情况下，智能体网络（agent web）可以像浏览器一样流畅读取你的文档。 - **优质的阅读体验** —— 全文搜索、明亮/深色主题、无障碍导航、面包屑、分页以及移动端侧边栏。 - **写作辅助护栏** —— 文章结构与格式的 Lint 检查、MDX 组件验证器，以及配置验证（出现错误时会以人类易读的格式报错）。 - **版本化文档，随时启用** —— 支持并行版本管理，包含备用版本链接、规范链接（canonical links）和自动重定向。 ## 为什么选择 Nimbus **你拥有每一个文件。** 脚手架工具会一次性生成你的布局、组件和设计 token，然后就会退居幕后。修改 Tailwind 类名、重构布局、删除你不需要的内容——这是你自己的代码库，而不是一个需要你小心翼翼去适配主题的依赖。 **人类和智能体都是一等公民。** 默认情况下就会提供可被智能体读取的交互面，而不是作为附加组件，因此编程智能体和更广泛的智能体网络可以像人类一样便捷地获取你的文档内容。 ## 技术基础 [Astro 7](https://astro.build) · Sätteri（基于 Rust 的 markdown 解析器） · Tailwind v4 · 可选的 React 19。输出为静态产物，因此可以部署到任何地方——并拥有指向 Cloudflare 的一等支持路径。 ## 当前状态 **开发中。** Nimbus 仍处于 1.0 版本之前（`0.x`）且迭代迅速。你现在就可以用它构建真实的站点，但其公开部分可能仍会在次要版本之间发生变化，并且存在一些粗糙之处。请在升级前锁定你的版本，并查看每个包的更新日志。 ## 贡献指南 Nimbus 依托于 issue 和讨论进行推进，而非不经沟通的 PR（Pull Request）——维护者会首先审核通过你的 issue 或讨论，随后你的 PR 才会保持开启状态。请参阅 [CONTRIBUTING.md](./CONTRIBUTING.md) 了解如何开始，并查看 [`CLAUDE.md`](./CLAUDE.md) 了解架构和面向智能体的上下文信息。 ## 许可证 [MIT](./LICENSE)

标签：Astro, Cloudflare, MITRE ATT&CK, 可视化界面, 文档站点, 程序员工具, 脚手架工具, 自动化攻击, 静态网站生成