Skip to content

智能体文档

通过备用 Markdown/MDX 版本、llms.txt 索引和结构化元数据,让 AI 工具能够访问文档。

AI 生成 · 待审阅更新于 查看 Markdown

Nimbus 通过端点提供文档,AI 工具无需解析 HTML 站点即可读取。

提供的内容

  • 每个可发现页面的备用 Markdown/MDX 版本 — /<slug>/index.md 包含组件已转换为文本的纯净 Markdown,而 /<slug>/index.mdx 则保留导入、JSX 和指令。Nimbus 在构建时解析链接和可复用代码片段。.md 版本会链接到其 .mdx 源文件。API 参考页面仅有 .md 版本。隐藏版本不会生成任何文件。
  • 站点 llms.txt 索引 — 列出当前文档的顶级页面和分节索引。每个分节索引将其可发现页面链接到对应的备用 Markdown 版本。旧版文档不会被列出;每个版本都有自己的索引,位于 /<version>/llms.txt。
  • llms-full.txt — 将所有可发现页面合并为一个 Markdown 文档,不包括非当前版本的内容。AI 工具和索引系统可以通过一次请求获取当前站点。Nimbus 在构建时生成该文件,因此重新构建的结果是字节一致的。
  • 每个分节的索引,位于 /<section>/llms.txt — 每个顶级分组和集合(例如 blog 或文档版本)都有自己的索引。
  • 版本标签 — 在版本化站点上,每个备用 Markdown 版本的 frontmatter 都包含 version: 键(从你的 versions 清单中解析),以便智能体锁定特定版本。非版本化站点不会生成此项。
  • 每个页面头部的 JSON-LD — 结构化数据,帮助搜索引擎和智能体工具识别内容。
  • /robots.txt 和站点地图 — 设置 site 后自动配置。
/llms.txttext
# Nimbus

A way to build documentation sites on top of Astro.

## Pages
- [Get started](https://nimbus-docs.cn/get-started/index.md)
- [Installation](https://nimbus-docs.cn/installation/index.md)

页面索引方式

索引默认跨多个集合,且对 schema 容忍度高 — 在 src/content.config.ts 中注册的每个已准备的集合(partials 和保留名称除外)都会被遍历,并在存在时读取 title 和 description。没有逐页的加入机制;所有可发现页面都会被列出。隐藏版本会被排除,/llms-full.txt 也会省略非当前版本的内容。

备用 Markdown/MDX 版本和 llms.txt 索引使用公开的智能体端点资源。运行时授权无法保护私有内容的安全。请将私有内容放在公开内容集合之外。Nimbus 会省略被排除的条目,并在无法确定内容是否公开时导致构建失败。

要将页面排除在 llms.txt 索引之外,请设置 draft: true(完全排除)或 noindex: true。不应被智能体读取的页面不应放在内容集合中。

自定义内容加载器

Nimbus 的集合工厂会自动准备 Markdown。如果自定义加载器为备用 Markdown 版本或 llms-full.txt 保留了 Markdown 正文,请使用 @cloudflare/nimbus-docs/content 中的 withNimbusMarkdown() 进行包装。完整示例请参阅其他集合。

路由设置

新项目已包含这些路由。要在现有项目中添加或更新它们,请参阅 Markdown 和 llms.txt 端点。

AGENT.md

脚手架工具会在项目根目录生成 AGENT.md — 这是编程智能体在你的仓库中工作时读取的上下文。这是一个你需要维护的真实文件;请使其与项目规范保持同步。

为什么这很重要

在智能体网络中成为一个死胡同的代价是真实且不断增长的。由于这些文件和元数据是默认提供的,Nimbus 站点在上线当天即可被智能体识别 — 有关人类搜索方面的信息,请参阅元数据与 SEO。

导航

输入以搜索…

↑↓ 导航↵ 选择Esc 关闭