Codexリソース

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

概要

zudo-docは、プロジェクト内のCodexリソースからドキュメントページを自動生成できます。対象となるのは、AGENTS.mdファイル、設定プロファイル、カスタムエージェント、フック、ルール、スキルです。有効にすると、生成されたページはヘッダーナビゲーションのCodexセクションに表示されます。

Codexリソースの有効化

zfb.config.tsでcodexResourcesを設定します：

export default defineConfig(
  zudoDoc({
    codexResources: {
      codexDir: ".codex",
    },
  }),
);

インテグレーションを無効にするにはfalseを設定します：

codexResources: false,

生成されるもの

インテグレーションは以下のドキュメントセクションを生成します：

リソースごとにインデックスページが作られ、検出された各リソースは個別の詳細ページとして表示されます。

仕組み

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

1. projectRoot、scanRoot、設定された.codex/ディレクトリを解決

2. scanRootを探索してAGENTS.mdとAGENTS.override.mdを検出

3. 設定された各リソースの場所から、設定、エージェント、フック、ルール、スキルを検出

4. 7つのcodex*ディレクトリにインデックスページと詳細ページのMDXを生成

5. 生成したページをzfbのコンテンツコレクションから利用できる状態にする

生成されたページは、ヘッダーナビゲーションのCodexタブに表示されます。すべてのCodex生成セクションでタブをアクティブにするには、categoryMatch: "codex"を設定します。

ヘッダーアイテムにはversioned: falseを設定してください。Codexの生成ルートが作られるのはデフォルトのdocsDirだけで、/v/{version}配下には生成されません。バージョン対応のリンクにすると、過去バージョンの表示中に存在しないルートを指してしまいます。

設定オプション