llms.txtllms-full.txt

以 Markdown 格式查看

llms.txt 是一个向 AI 开发工具暴露网站内容的标准。Fern 实现了这个标准,自动生成和维护 llms.txtllms-full.txt Markdown 文件,以便 AI 工具可以发现和索引您的文档。

Fern 还在任何页面 URL 上提供干净的 Markdown 而不是 HTML,当请求包含 Accept: text/markdown 头时,确保代理只接收它们需要的内容。这些功能结合在一起可以减少 90% 以上的 token 消耗。

使用 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

页面描述

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

Frontmatter
1---
2title: Fern Docs
3subtitle: Build beautiful documentation websites with Fern.
4---

输出格式取决于您是否请求单个页面或部分:

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

.../page/llms.txt and .../page/llms-full.txt
# Fern Docs
> Build beautiful documentation websites with Fern.

了解更多