Skip to content

快速开始

在 Astro 上构建文档站点,人类和智能体都是一等公民——而且你拥有每一个文件。

更新于 查看 Markdown
面向人类

Nimbus 在 Astro 上构建文档站点。它将底层基础设施作为 npm 包发布,并将可见部分——布局、组件、样式、内容——作为真实文件写入你的仓库,从第一天起就由你拥有。

核心优势

  • 你拥有所有代码。 脚手架工具写入布局、组件和样式后便不再干预。没有需要 fork 的上游主题,没有需要等待的 API。你可以编辑任何文件。
  • 人类和智能体都是第一公民。 每个可发现的页面都提供 Markdown 版本,/llms.txt 索引整个站点,JSON-LD 嵌入每个页面的 <head>——让智能体网络能像浏览器一样阅读你的文档。
  • 与智能体协作构建。 nimbus-docs add 从注册表安装,支持两种模式:组件以文件形式复制,功能则提供配方供编程智能体读取并应用。

快速开始

npx @cloudflare/create-nimbus-docs@latest

根据提示选择目录名、模板、输出模式和目标平台,然后:

cd my-docs
pnpm install
pnpm dev

打开终端输出的 URL,编辑 src/ 下的任何文件——开发服务器会自动重新加载。

下一步

安装

脚手架创建站点并了解仓库中生成了哪些文件——参见安装指南。

项目结构

你拥有的文件、包的边界,以及目录树如何变成站点——参见项目结构。

浏览组件

每个 UI 组件、每个变体,附带可复制粘贴的示例——访问 /components。

从注册表添加

nimbus-docs add <slug> 将组件复制到你的仓库——参见添加组件。

导航

输入以搜索…

↑↓ 导航↵ 选择Esc 关闭