MkDocs 内の llms.txt

ファイルの保存先

MkDocsは docs_dir （デフォルトでは docs/）を site/ フォルダ。Markdown ファイルは HTML ページに変換されますが、それ以外のファイル（ .txt、対応するパスにコピーされます。 site/。そのため docs/llms.txt は次で配信されます： /llms.txt.

このファイルは、ドキュメント一式をキュレーションしたマップとして扱います。インストールガイド、設定 リファレンス、APIページ、アップグレードノート、変更履歴を含めますが、生成された全ページを ファイルへ詰め込むことは避けてください。小さく保守されたリストのほうが、アシスタントにも人間にも監査しやすくなります。

方法：docs/ ディレクトリ

1. 以下のファイルを追加してください： touch docs/llms.txt
2. 主要なドキュメントページを整理します（ここではドキュメントこそ、アシスタントが必要とするものです）：

# 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.

3. 構築とデプロイ： 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ガイド. ファイル内容の構築については 以下の 作成方法ガイド; それを検証する バリデーター.