llms.txtllms-full.txt

llms.txt 是一个向 AI 开发者工具公开网站内容的标准。Fern 实现了这个标准,自动生成和维护 llms.txtllms-full.txt Markdown 文件,以便 AI 工具可以发现和索引您的文档。对于单个页面,代理还可以直接获取 Markdown

llms.txtllms-full.txt 是 Fern 为非人类消费者提供的根级文件,与 robots.txt 一起提供。robots.txt 决定哪些爬虫可以访问您的网站以及您广播什么 AI 训练信号;llms.txtllms-full.txt 塑造 AI 代理一旦访问后会收到什么内容。

使用 llms.txt 的示例

生成的文件

Fern 为 LLM 生成两个文件:

  • llms.txt 包含您的文档站点的轻量级摘要,每个页面都被提炼成一句话描述和 URL。对于包含 API 端点的站点,它还链接到您的 OpenAPI 规范作为独立的、机器可读的文件,以便 AI 工具可以直接解析您的完整 API 模式。对于包含 WebSocket 通道的站点,它还链接到您的 AsyncAPI 规范

  • llms-full.txt 包含完整的文档内容,包括所有页面的全文。对于 API 文档,这包括您的完整 API 参考,其中包含已解析的 OpenAPI 规范和启用语言的 SDK 代码示例。

这两个文件在您的文档层次结构的任何级别都可用(/llms.txt/llms-full.txt/docs/llms.txt/docs/ai-features/llms-full.txt 等)。

示例:Eleven Labs llms.txtCash App llms-full.txt

页面描述

两个文件都包含从前置内容中提取的页面描述。Fern 使用 description 字段(如果存在),否则回退到 subtitle

前置内容
1---
2title: Fern Docs
3subtitle: 使用 Fern 构建精美的文档网站。
4---

输出格式取决于您请求的是单个页面还是一个部分:

llms.txtllms-full.txt 返回相同的格式:

.../page/llms.txt 和 .../page/llms-full.txt
# Fern Docs
> 使用 Fern 构建精美的文档网站。

了解更多

HTTPS · buildwithfern.com
← Home