LLMs.txt
mdui は、LLM(大規模言語モデル)に正確で引用可能なコンテキストを提供する llms.txt と llms-full.txt を用意しています。これにより、AI は mdui 関連の質問に対してより正確に答えられるようになります。
llms.txt を使用して LLM にコンテキストを提供する
2 つのエントリポイントがあります:
llms.txt: https://www.mdui.org/ja/docs/2/llms.txtllms-full.txt: https://www.mdui.org/ja/docs/2/llms-full.txt
llms.txt は簡潔なインデックスで、ネットワークにアクセス可能なモデルがリンクを辿って必要な Markdown ページを取得したり、プロジェクトの概要を事前に把握するのに適しています。
llms-full.txt には llms.txt 内のすべてのページ内容を含む完全なコンテキストが含まれています。モデルがネットワークにアクセスできない場合や、完全なコンテキストを一度に提供する必要がある場合に適しています。
ドキュメントの Markdown バージョン
各ドキュメントページには対応する Markdown バージョンがあります。ページの URL の末尾に .md を追加するだけです(トップページは index.md を追加)。
例:
https://www.mdui.org/ja/docs/2/components/button → https://www.mdui.org/ja/docs/2/components/button.md
https://www.mdui.org/ja/docs/2/ → https://www.mdui.org/ja/docs/2/index.md
この Markdown リンクまたはそのプレーンテキストを直接コンテキストとして使用することで、より焦点を絞った正確な回答を得ることができます。
ChatGPT、Claude などの LLM での使用方法
モデルがネットワークアクセス/ファイルアップロードをサポートしているかどうかに応じて、以下のいずれか、または組み合わせて使用します:
直接貼り付け:
llms-full.txtの内容をシステムプロンプトまたは最初のメッセージとして貼り付けます。例:「以下は mdui のコンテキストです。これに厳密に従って後続の質問に回答してください。矛盾がある場合は、このコンテキストを優先してください:\n\n[llms-full.txt の内容を貼り付け]」。
ファイルをアップロード:
llms-full.txt(またはllms.txt)をアップロードし、最初のメッセージで「添付ファイルを主なコンテキストとしてください」と指示します。例:「添付された mdui ドキュメントに基づいて、
<mdui-button>の使用方法とよくある落とし穴を教えてください」。オンラインで読み込む:ダイアログで
llms.txtまたはllms-full.txtのリンクを指定します。例:「https://www.mdui.org/ja/docs/2/llms-full.txt を読み込み、それをコンテキストとして mdui に関する私の質問に答えてください」。
特定のページを指定:特定のコンポーネント/関数のみを扱う場合は、そのページの Markdown URL を直接指定します。
例:「https://www.mdui.org/ja/docs/2/components/button.md を読み込み、そのドキュメントに基づいてベストプラクティスを 3 つ挙げてください」。
ヒント:ページ右上の llms-full.txt をコンテキストとして ChatGPT で開くことができます。