nimbus README

项目的 README,来自 github.com/cloudflare/nimbus。合并为一个 markdown 文件:README.md。

Nimbus

Nimbus is a documentation framework for Astro: docs for humans and agents, in your repo. It scaffolds the site into your repository, checks the content you and your agents write, and publishes it as HTML for people and Markdown for agents.

Docs: nimbus-docs.com

Quickstart

Requires Node.js 22.23.4 or later.

npx @cloudflare/create-nimbus-docs@latest my-docs --yes --package-manager npm
cd my-docs
npm run dev

Pages live in src/content/docs/ as MDX or Markdown. Start with src/content/docs/index.mdx, and set the site's URL, title and description in astro.config.ts; they ship as placeholders.

How it works

Features

Writing:

Checking:

Publishing for agents:

Deploy

Sites are static by default: npm run build, then host the output anywhere. Rendering pages on request and the remote MCP server need a server adapter (Cloudflare, Netlify, Vercel or Node); see Deploy.

Packages

Package What it is
@cloudflare/create-nimbus-docs Creates a new site.
@cloudflare/nimbus-docs The Astro integration and the nimbus-docs CLI.

Status

Pre-1.0. The public API can change between minor releases. Pin your versions and read each package's changelog (nimbus-docs, create-nimbus-docs) before upgrading. Upgrade a Nimbus site walks through one.

Contributing

Pull requests are welcome; for anything bigger than a small fix, start with an issue or a discussion. See CONTRIBUTING.md, and CLAUDE.md for the architecture and agent context.

License

MIT

nimbus (cloudflare/nimbus)

正在搜索数据库…

1.8K ·GitHub
这是什么?Nimbus 是一个基于 Astro 的文档编写工具。它会在你的代码仓库中创建文档网站,检查你和你的智能体编写的内容,并发布面向用户的 HTML 以及面向智能体的 Markdown。
它是一个库还是现成的文档网站?两者兼有:脚手架工具会把网站代码(布局、组件、路由、内容)复制到你的代码仓库中,方便你自行修改;而 @cloudflare/nimbus-docs 包则提供 Astro 集成、辅助函数和命令行工具。
我该如何让它运行起来?你需要 Node.js 22.12.0 或更高版本。使用 @cloudflare/create-nimbus-docs 包创建网站,在 src/content/docs/ 中以 MDX 或 Markdown 编写页面,从 index.mdx 开始;然后在 astro.config.ts 中设置网站地址、标题和描述,这些文件默认是占位内容。
它足够稳定,可以放心使用吗?它目前处于 1.0 之前的版本,因此公共 API 可能会在次要版本之间发生变化。请固定你的依赖版本,并在每次升级前阅读 nimbus-docs 和 create-nimbus-docs 的更新日志。
一定要把它部署在 Cloudflare 上吗?不必。静态构建可以部署到任何地方。只有按需渲染和远程 MCP 服务器才需要 Cloudflare、Netlify、Vercel 或 Node。
它能从其他来源拉取文档吗?可以。它支持文档版本和搜索,还可以加载其他 Git 仓库或 Notion 中的页面。
内置了哪些 MDX 组件?代码块、标签页、步骤、卡片、文件树、可复用片段和交互式图表。其中一些组件可以通过 nimbus-docs add 按需安装。
lint 警告会阻止我的构建吗?不会。nimbus-docs lint 会依据 astro.config.ts 中的规则报告编写错误,但不会阻止构建。
大小
15.1 MB
星标
1.8K
时长
4个月
提交 · 90 天