> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify-mintlify-add-hello-world-quickstart-48843.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# llms.txt

> 让大语言模型更易读取与索引你的内容

export const PreviewButton = ({children, href}) => {
  return <a href={href} className="text-sm font-medium text-white dark:!text-zinc-950 bg-zinc-900 hover:bg-zinc-700 dark:bg-zinc-100 hover:dark:bg-zinc-300 rounded-full px-3.5 py-1.5 not-prose">
        {children}
      </a>;
};

[llms.txt 文件](https://llmstxt.org) 是一种行业标准，可帮助大语言模型更高效地索引内容，类似于站点地图之于搜索引擎的作用。AI 工具可以利用该文件理解你的文档结构，并找到与用户问题相关的内容。

Mintlify 会在你的项目根目录自动托管一个 `llms.txt` 文件，列出文档中的所有可用页面。该文件始终保持最新且无需维护。你也可以选择在项目根目录添加自定义的 `llms.txt` 文件。

在你的文档站点 URL 末尾追加 `/llms.txt`，即可查看你的 `llms.txt`。

<PreviewButton href="https://mintlify.com/docs/llms.txt">打开此站点的 llms.txt</PreviewButton>

<div id="llmstxt-structure">
  ## llms.txt 结构
</div>

`llms.txt` 是一个纯 Markdown 文件，包含：

* 以 H1 标题呈现的**站点标题**。
* **结构化的内容分区**，包含指向文档中各页面的链接及其描述。

```mdx llms.txt 示例
# 示例产品文档

## 指南
- [快速上手](https://example.com/docs/start): 入门引导
- [安装](https://example.com/docs/install): 安装步骤

## 参考
- [API](https://example.com/docs/api): 端点列表与用法
```

这种结构化方法使大型语言模型能够高效地在高层次处理你的文档，并为用户查询定位相关内容，从而提升 AI 辅助文档搜索的准确性和速度。

<div id="llms-fulltxt">
  ## llms-full.txt
</div>

`llms-full.txt` 文件会将你的整个文档站点合并为一个文件，作为 AI 工具的上下文，并会被大型语言模型的流量抓取和索引。

Mintlify 会在你的项目根目录自动托管一个 `llms-full.txt` 文件。将 `/llms-full.txt` 追加到你的文档站点 URL 后即可查看该文件。

<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` 文件。添加自定义文件会覆盖同名的自动生成文件。若删除自定义文件，将恢复使用默认文件。

你的自定义 `llms.txt` 或 `llms-full.txt` 文件必须包含一个网站标题，并以 H1 级标题标注。其他内容可选。有关可选部分和最佳实践的更多信息，请参见 `llms.txt` 规范中的[格式](https://llmstxt.org/#format)。