# LLMs.txt

EMQX Edge 文档提供 `llms.txt` 文件。该文件是面向大语言模型（LLM）的结构化文档索引，帮助 AI 工具和代理快速发现并引用 EMQX Edge 文档内容，从而在使用 AI 编程助手时获得更准确、更相关的结果。

## 什么是 llms.txt？

`llms.txt` 是放置在标准 URL 路径下的纯文本文件，用于列出某个产品的关键文档页面。它遵循 [llms.txt specification](https://llmstxt.org/)，这是一项用于让文档更适合 AI 使用的开放标准。

当 AI 工具支持 `llms.txt` 时，你可以将该文件提供给工具，使其以结构化、最新的方式访问 EMQX Edge 文档，而无需手动粘贴内容。

::: tip
`llms.txt` 文件会在每次文档构建时自动生成，因此始终反映最新的文档结构和内容。
:::

## 可用文件

顶层索引文件列出了所有 EMQX 产品和版本可用的 `llms.txt` 文件：

```
https://docs.emqx.com/llms.txt
```

EMQX Edge 文档也有自己的 `llms.txt`：

```
https://docs.emqx.com/zh/emqx-edge/latest/llms.txt
```

将 AI 工具指向顶层索引后，它可以自行发现完整列表，并导航到正确的产品文档。

## 在 AI 工具中使用

将你的 AI 工具或编程助手指向顶层 `llms.txt` URL：

```
https://docs.emqx.com/llms.txt
```

具体添加方式取决于工具。有些工具允许你在设置中直接注册文档源；有些工具则支持将 URL 粘贴到提示词中。如果不确定，可以直接询问你的 AI 工具。例如：

```
How do I add https://docs.emqx.com/llms.txt as a documentation source?
```

AI 工具会了解其自身界面的当前操作步骤。

## 以 Markdown 形式访问文档

任意 EMQX Edge 文档页面都可以通过将 URL 中的 `.html` 替换为 `.md` 来获取原始 Markdown 内容。这对于将特定页面直接提供给 AI 工具或脚本很有用：

```
# HTML page
https://docs.emqx.com/zh/emqx-edge/latest/mqtt-stream/mqtt-stream-user-guide.html

# Same page as Markdown
https://docs.emqx.com/zh/emqx-edge/latest/mqtt-stream/mqtt-stream-user-guide.md
```