Docusaurusでのllms.txt

ドキュメントサイトは llms.txt の有力な導入候補です。Docusaurus では static/ にファイルを1つ置くだけです。

最終更新:

ファイルの保存先

Docusaurusは、 static/ 構築されたサイトのルートディレクトリ。 にあるファイル static/llms.txt は次で配信されます: /llms.txt。Docusaurusは ドキュメント用であるため、 llms.txt を支える場合、主要なドキュメントページをマップする llms.txt は AI アシスタントにとって特に有用です。

ファイルは短く、目的を明確に保ちます。すべてのサイドバー項目ではなく、概要ページ、APIリファレンス、 バージョン別ドキュメント、変更履歴、サポートポリシーへアシスタントを案内します。ドキュメントでルート以外の baseUrl、公開 URL とビルド後のパスの両方を確認してからファイルを発表します。

方法:static/ フォルダー

  1. 以下のファイルを追加してください: touch static/llms.txt
  2. 最も有用なドキュメントページを一覧にします( 作成方法ガイド):
# Your Project Docs

> Documentation for Your Project: guides, API reference, and tutorials.

## Guides

- [Getting started](https://yourdomain.com/docs/intro): installation and first steps.
- [Configuration](https://yourdomain.com/docs/config): all options explained.

## Reference

- [API reference](https://yourdomain.com/docs/api): full endpoint catalog.
  1. ビルドしてデプロイ: npm run build.

baseUrlに注意

設定の確認

curl -sI https://yourdomain.com/llms.txt | grep -i content-type
# expect: content-type: text/plain

GitHub Pagesでドキュメントをホストしていますか? GitHub Pagesガイド で ルートパスに関する注意事項を確認してください。全文版には llms-full.txtを追加し、その後、両方を バリデーター.

ソース