read-docs について
read-docsは、Fumadocsで構築されたドキュメントサイトから正確な情報を取得するスキルです。ページ一覧、Markdownエンドポイント、検索APIを優先し、描画済みページのスクレイピングを避けます。
主な機能
- 01llms.txtによるページの発見
- 02処理済みMarkdownの取得
- 03APIを使ったドキュメント検索
- 04参照元URLの提示
活用シーン
- 01特定のドキュメントページの発見
- 02機能や概念の検索
- 03最新のプロジェクト文書に基づく回答
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ fuma-nama/ fumadocs --skill read-docsインストール後、Claude Code で/read-docsを入力して読み込まれたか確認します。
詳細
Fumadocs で構築されたドキュメントサイトから、正確で整ったコンテンツを探索・取得するための専用スキルです。
Fumadocs を利用したサイトでは、通常、LLM に適した次の 3 つの機能が提供されています。
-
llms.txt によるページの探索
サイトのルート URL にプレーンテキストファイル/llms.txtが用意されています。
このファイルには、クロール可能なルートの一覧(1 行につき 1 つ)が含まれており、多くの場合、ドキュメントページであるパスを示すコメントやメタデータも記載されています。 -
ドキュメントページの処理済み Markdown
Fumadocs のテンプレートでは、多くの場合、各ページの/llms.mdx/docs/<path>/content.mdで処理済み Markdown(MDX から生成されたプレーンな Markdown)が公開されています。サイトによっては、ミドルウェアを通じて/docs/.../page.mdxの書き換えやAccept: text/markdownのネゴシエーションにより、この URL が使われることもあります。
例:- レンダリングされたページ:https://example.com/docs/installation
- LLM 向けの Markdown:https://example.com/llms.mdx/docs/installation/content.md
サイトで公開されている場合は、HTML のスクレイピングよりこちらを優先してください。
-
検索 API
サイトでは、JSON 形式の検索エンドポイントが公開されています。
GET /api/search?query=
構造化された結果(通常は、タイトル、抜粋、URL、場合によっては階層を含むオブジェクトの配列)が返されます。
ユーザーのクエリに、公式ドキュメントが Fumadocs サイトで公開されているライブラリ、ツール、フレームワーク、またはプロジェクトが関係する場合:
- まず、Fumadocs が使われていることを確認します(ユーザーからの確認、既知のプロジェクト、または
/llms.txtの取得成功によって確認できます)。 /llms.txtを取得し、利用可能なページの一覧をすべて確認します。- 特定のドキュメントページの内容を取得する際は、Markdown エンドポイント(多くの場合、
/llms.mdx/docs/以下の.../content.md)か、サイトがその形式を採用している場合はドキュメントパスに.mdxを付けた URL を優先します。 - ユーザーが何か(キーワード、機能、概念など)を探している場合は、
/api/searchエンドポイントで具体的なクエリを使用します。 - 生の MDX または JSON の結果を解析して推論し、正確で最新の回答を提供します。
- 出典の正確な URL を記載します(ユーザーにとって見やすい元のレンダリング済み URL を優先しますが、内容の確認には生データを使用します)。
ノイズを最小限に抑え、正確性を最大限に高めるため、レンダリング済み HTML のスクレイピングより、これらのエンドポイントを優先してください。