如何在发布前验证 llms.txt 文件

损坏的 llms.txt 比没有 llms.txt 更糟糕。如果文件格式错误，读取该文件的工具和模型就会得到令人困惑或不完整的网站图片 - 与您想要的相反。好消息：llms.txt 格式很简单，因此一旦您知道要检查什么，验证就会很快。

这是一个实用、简洁的清单，您可以在每次发布之前运行。

格式实际需要什么

llms.txt 格式（来自 llmstxt.org）是有意最小化的 Markdown：

单个 H1 标题 命名项目 - 文件的第一行。
标题后面可选但推荐的摘要引用 (> …)。
零个或多个 H2 部分（## Docs、## API，…），每个部分包含一个链接列表。
每个链接都是一个列表项：- [Name](https://example.com/page): short description。

这就是整个结构。大多数验证问题都是与此形状的偏差。

预发布清单

1. 正好一个 H1，而且是第一个

该文件应使用一行 # Title 打开。常见错误：

根本没有 H1（文件以散文或列表开头）。
多个 H1（对部分使用 ## 代替）。
H1 埋在其他内容之下。

2.摘要块引用

在标题后面添加一行 > 块引用来描述站点或项目的内容。它为任何读者（模型或人类）提供即时背景。它在规范中是可选的，但在实践中是推荐的。

3. 对链接进行分组的部分

使用 ## 标题对相关链接进行分组：## Documentation、## API Reference、## Guides。没有任何部分的扁平链接转储很难导航。如果您有多个链接，请将它们分组。

4. 格式良好的链接

检查每个链接：

空 URL, [Docs]()，括号内不包含任何内容。
缺少链接文本, [](https://…) 无标签。
格式错误的 URL, 拼写错误、缺少 https://、杂散字符。
重复链接, 同一 URL 多次出现会浪费空间并发出复制粘贴错误信号。

5. 每个链接的说明

裸露的 - [Quickstart](https://…) 远不如 - [Quickstart](https://…): Get set up in five minutes 有用。该描述告诉模型_为什么_该链接很重要以及_何时_关注它。向每个列表项链接添加一个。

6. 保持简洁

llms.txt 是索引，而不是存档。如果您的文件非常大（数十千字节或更多），则表明您正在将完整内容填充到策划的链接列表所属的位置。

7. 考虑一个配套的 llms-full.txt

如果您确实有很多可能需要完整内容的长格式内容模型，请发布包含完整文本的单独 llms-full.txt，并将 llms.txt 保留为链接到它的轻量级地图。

干净文件的快速示例

# Acme Docs

> Acme is an API for sending transactional email. This file indexes the docs and reference.

## Getting Started

- [Quickstart](https://acme.dev/quickstart): Send your first email in five minutes
- [Authentication](https://acme.dev/auth): API keys and scopes

## API Reference

- [Messages API](https://acme.dev/api/messages): Create and send messages
- [Webhooks](https://acme.dev/api/webhooks): Delivery and bounce events

## Optional

- [Changelog](https://acme.dev/changelog): Release notes

一个 H1，一个摘要，分组的部分，描述的链接，没有重复。这就是目标。## 自动验证

手动运行检查表是可行的，但很容易错过长文件中重复的 URL 或缺失的描述。我们的免费 llms.txt 验证器一次性检查上述所有内容，并为您提供结构分数以及具体的、行感知的建议。

您可以通过两种方式进行验证：

将您的内容直接粘贴到验证器中，或者
输入 URL, 将其指向您的站点（我们将自动获取 /llms.txt）或直接链接到该文件。这对于检查已经存在的文件非常方便。

无论哪种方式，您都会在发布之前或之后准确地看到需要修复的内容。

解决问题后

一旦验证者满意：

将文件另存为 llms.txt 并将其上传到您的域根目录 (https://example.com/llms.txt)。
针对实时 URL 重新运行验证器，以确认其以纯文本形式提供且可访问。
每当您重组网站或添加主要部分时，请重新检查它。

底线

验证需要几分钟的时间，并且可以使您免于传送会悄悄误导读取该文件的工具的文件。运行检查表，修复结构，并在发布之前与 validator 确认。

还没有文件？使用 llms.txt 生成器从您的网站生成干净的草稿，然后对其进行验证。如果您仍在决定是否需要一个，请参阅当 llms.txt 有意义时。