跳到正文

简介

Nimbus 是什么、适合谁,以及从哪里开始。

Nimbus 是一个基于 Astro 构建的文档写作工具。它在你的仓库里创建一个文档站点,检查你和你的智能体写下的内容,并把它们发布为面向人的 HTML 和面向智能体的 Markdown。

为什么使用 Nimbus

  • 内容属于你的仓库。 布局、组件、路由和页面都以源码形式放在项目里,没有任何部分被锁在依赖中。
  • 为智能体而写。 每个页面都有对应的 Markdown 版本,站点还会生成 llms.txt、llms-full.txt 和可选的远程 MCP 服务器。
  • 构建期校验。 配置、frontmatter 和 MDX 组件都会在构建时检查;nimbus-docs check 还能在不构建的情况下提前发现问题。
  • 按需扩展。 标签页、步骤、卡片、文件树等组件可以从组件注册表安装;API 参考、版本管理与搜索也可以逐步接入。

开始使用

  1. 创建站点

    bun create @cloudflare/nimbus-docs@latest my-docs --yes
    cd my-docs
  2. 启动开发服务器

    bun run dev
  3. 编辑首页

    打开 src/content/docs/index.mdx,修改标题并保存。页面会带着你的改动重新加载。

打开 http://localhost:4321,你会看到带有侧边栏的文档站。

接下来

输入以搜索…

↑↓ 导航↵ 选择Esc 关闭