mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
locadex-agent[bot]
c1171a757b
Co-authored-by: locadex-agent[bot] <217277504+locadex-agent[bot]@users.noreply.github.com>
63 lines
3.0 KiB
Plaintext
63 lines
3.0 KiB
Plaintext
---
|
||
title: "llms.txt"
|
||
description: "为 LLM 优化文档，提升其可读性与索引效果。"
|
||
keywords: ["llms.txt", "LLM 索引编入", "AEO", "GEO", "内容发现"]
|
||
---
|
||
|
||
import { PreviewButton } from "/snippets/previewbutton.jsx"
|
||
|
||
[llms.txt 文件](https://llmstxt.org) 是一种行业标准，可帮助大语言模型（LLM）更高效地索引内容，类似于站点地图对搜索引擎的作用。AI 工具可以使用此文件理解你的文档结构，并定位与用户查询相关的内容。
|
||
|
||
Mintlify 会在项目根目录自动托管一个 `llms.txt` 文件，列出文档中的所有可用页面。该文件始终保持最新且无需维护。你也可以在项目根目录添加自定义的 `llms.txt` 文件。
|
||
|
||
<Note>
|
||
如果你的站点在访问文档时需要认证，你的 `llms.txt` 和 `llms-full.txt` 文件将不会对 LLM 和 AI 工具开放。LLM 和 AI 工具只能索引公开可访问的内容。
|
||
</Note>
|
||
|
||
将 `/llms.txt` 追加到你的文档站点 URL 后查看 `llms.txt`。
|
||
|
||
<PreviewButton href="https://mintlify.com/docs/llms.txt">打开此站点的 llms.txt。</PreviewButton>
|
||
|
||
|
||
<div id="llmstxt-structure">
|
||
## llms.txt 结构
|
||
</div>
|
||
|
||
`llms.txt` 文件是一个纯 Markdown 文件，包含：
|
||
|
||
* 以 H1 标题形式呈现的**站点标题**。
|
||
* **结构化内容部分**，包含链接以及文档中每个页面的说明。
|
||
|
||
页面按在存储库中的位置以字母顺序列出，从根目录开始。
|
||
|
||
每个页面的说明来自其 frontmatter 中的 `description` 字段。没有 `description` 字段的页面将在 `llms.txt` 中显示，但不含说明。
|
||
|
||
```mdx Example llms.txt
|
||
# 站点标题
|
||
|
||
## 文档
|
||
|
||
- [API](https://example.com/docs/api): 端点列表和使用方法
|
||
- [安装](https://example.com/docs/install): 设置步骤
|
||
- [快速开始](https://example.com/docs/start): 入门指南
|
||
```
|
||
|
||
这种结构化方法使 LLM 能够高效地从宏观层面处理你的文档，并为用户查询定位相关内容，从而提升 AI 辅助文档搜索的准确性和速度。
|
||
|
||
<div id="llms-fulltxt">
|
||
## llms-full.txt
|
||
</div>
|
||
|
||
`llms-full.txt` 文件会将你的整个文档站点整合为一个文件，供 AI 工具作为 context 使用，并由 LLM 流量进行索引。
|
||
|
||
Mintlify 会在你的项目根目录自动托管一个 `llms-full.txt` 文件。你可以在文档站点的 URL 末尾追加 `/llms-full.txt` 来查看该文件。
|
||
|
||
<PreviewButton href="https://mintlify.com/docs/llms-full.txt">打开此站点的 llms-full.txt</PreviewButton>
|
||
|
||
<div id="custom-files">
|
||
## 自定义文件
|
||
</div>
|
||
|
||
要添加自定义的 `llms.txt` 或 `llms-full.txt` 文件，请在项目根目录创建同名文件。添加自定义文件会覆盖同名的自动生成文件。删除自定义文件后，将恢复使用默认文件。
|
||
|
||
自定义的 `llms.txt` 或 `llms-full.txt` 文件必须包含一个以 H1 标题呈现的站点标题。其他内容为可选。有关可选部分和最佳实践的更多信息，请参阅 `llms.txt` 规范中的[Format](https://llmstxt.org/#format)。 |