zudo-doc
GitHub リポジトリ

検索したい単語を入力

いつでも検索バーを開ける

Claude Codeリソース

作成 2026年3月13日更新 2026年8月31日Takeshi Takatsudo

Claude Codeリソースからドキュメントを自動生成します。

概要

zudo-docはプロジェクトのClaude Codeリソース — CLAUDE.mdファイル、カスタムコマンド、スキル、エージェント — からドキュメントページを自動的に生成できます。有効にすると、これらはClaudeヘッダーナビゲーションセクションに表示されます。

Claude Resourcesの有効化

zfb.config.tsclaudeResourcesを設定します:

zfb.config.ts
export default defineConfig(
  zudoDoc({
    claudeResources: {
      claudeDir: ".claude",
    },
  }),
);

無効にするにはfalseに設定します:

claudeResources: false,

生成されるもの

インテグレーションは.claude/ディレクトリをスキャンし、以下のMDXドキュメントページを生成します:

リソースソース出力
CLAUDE.mdファイルプロジェクトルートとサブディレクトリclaude-md/
コマンド.claude/commands/*.mdclaude-commands/
スキル.claude/skills/*/SKILL.mdclaude-skills/
エージェント.claude/agents/*.mdclaude-agents/

各リソースタイプには、すべてのアイテムのリストを含むインデックスページと個別の詳細ページが用意されます。

仕組み

インテグレーションはzfbプラグイン(@takazudo/zudo-doc/plugins/claude-resources)として、ビルド時に動作します。このプラグインはclaudeResourcesが設定されていればzudoDoc()が自動的に組み込みます。preBuildフックで以下を行います:

  1. 設定された.claude/ディレクトリをスキャン

  2. CLAUDE.mdファイル、コマンド、スキル(リファレンス付き)、エージェントを検出

  3. src/content/docs/claude-*/ディレクトリにMDXファイルを生成

  4. これらのファイルはzfbのコンテンツコレクションによって取得され、ドキュメントページとしてレンダリング

生成されたページはClaudeヘッダーナビゲーションタブに表示されます。headerNavcategoryMatch: "claude"を設定して構成します。

Note

生成されたファイルはsrc/content/docs/に書き込まれ、ビルドごとに再作成されます。手動で編集しないでください — 変更は上書きされます。

ロケールごとの挙動

概要ページとカテゴリインデックスは、設定済みの各ロケールに生成されます。タイトル、説明、ラベルにはresource.*のUI文字列が使われます。個別リソース本文の正本となるソースダンプはデフォルトのコンテンツディレクトリに置かれます。本文の言語は元のソースファイルに従うため、必ずしも英語ではありません。ロケール付きルートでは未翻訳バナーを出さず、ローカライズされたナビゲーションとクロームの中にその本文を表示します。言語切り替えには設定済みの全ロケールへのリンクが残ります。

パッケージが同梱するresource.*文字列は英語と日本語です。他の対応ロケールコードは、通常どおり要求ロケール → 設定済みデフォルト → 英語 → リテラルの順でフォールバックします。ラベルはZudoDocConfig.translationsで上書きできます。保存方針の理由、llms.txtと検索の挙動、defaultLocaleOnlyPrefixesによるオプトアウトは国際化を参照してください。

設定オプション

オプション説明
claudeDirstring.claude/ディレクトリへのパス(プロジェクトルートからの相対パス)
projectRootstringCLAUDE.mdファイルパスの解決に使用するオプションのプロジェクトルートオーバーライド
scanRootstringCLAUDE.mdの探索に使用する省略可能なリポジトリ全体のルート。デフォルトはprojectRoot

projectRootオプションは、.claude/ディレクトリがプロジェクトルートにないモノレポ設定で便利です。

Tip

references/サブディレクトリを持つスキルは、そのリファレンスドキュメントが個別のリンクされたページとして含まれるため、バンドルされたナレッジベースを簡単に閲覧できます。

Revision History

Takeshi Takatsudo作成: 2026-03-14T08:14:41+09:00更新: 2026-09-01T07:39:24+09:00

AI Assistant

Ask a question about the documentation.

Preview theme

Loading theme previews…