MkDocs 中的 llms.txt
MkDocs 会把 docs/ 中的每个文件复制到站点根目录,因此 llms.txt 只需放在那里并保持不进入导航。
最近更新:
文件放在哪里
MkDocs 会将你的 docs_dir (默认情况下 docs/)构建到一个 site/
文件夹。Markdown 文件会变成 HTML 页面;其他所有文件,包括 .txt,会 被复制到 site/。因此, docs/llms.txt 由 /llms.txt.
将该文件视为文档集合的精选地图。应包含安装指南、配置参考、API 页面、升级说明和更新日志,但不要将所有生成页面都塞入文件。较小且持续维护的列表更便于助手和人类审核。
方法:docs/ 目录
- 添加文件:
touch docs/llms.txt - 列出您的关键文档页面(文档正是助手在此需要的内容):
# Your Project Docs
> Documentation for Your Project: installation, usage, and API reference.
## Guides
- [Installation](https://yourdomain.com/install/): setup and requirements.
- [User guide](https://yourdomain.com/guide/): day-to-day usage.
## Reference
- [API](https://yourdomain.com/api/): full reference.
-
构建并部署:
mkdocs build(或mkdocs gh-deploy(若使用 GitHub Pages)。
不要将其加入导航
验证设置
curl -sI https://yourdomain.com/llms.txt | grep -i content-type
# expect: content-type: text/plain 要将文档发布到 GitHub Pages?请留意 GitHub Pages 指南。文件内容的构建方法在 操作指南;使用 验证器.