create-zudo-doc CLI

create-zudo-doc プロジェクトスキャフォルダーの完全な CLI リファレンス。

使い方

create-zudo-doc [project-name] [options]

フラグなしで実行すると、対話式ウィザードが起動します。すべてのオプションはフラグで指定でき、非対話的（CI/エージェント）に使用できます。

セットアッププリセットジェネレーターを使って、対話的に設定を構成し、JSON プリセットまたは CLI コマンドとしてコピーすることもできます。

オプション

プロジェクト

カラースキーム

利用可能なカラースキーム

シングルモードのスキーム（--color-scheme-mode single）

--scheme <name> で指定します。デフォルトは Dracula です。

ダークスキーム:

ライトスキーム:

ライト/ダークペアリング（--color-scheme-mode light-dark）

--light-scheme と --dark-scheme で指定します。デフォルトはライトが Default Light、ダークが Default Dark です。

ペアリング名は対話式ウィザードおよびセットアッププリセットジェネレーターで表示されます。CLI フラグを直接使用する場合は、ライトとダーク各スキームの名前を個別に指定してください。

機能

プリセット

--preset フラグはセットアッププリセットジェネレーターの JSON 出力を受け付けます。プリセットを読み込むと、すべてのプロンプトがスキップされます（--yes と同様）。個別の CLI フラグはプリセットの値を上書きします。

一般

サポート言語

--lang フラグは以下の言語コードを受け付けます:

デフォルト言語は、ルートページ（/docs/...）で使用されるロケールを決定します。i18n が有効な場合、セカンダリ言語が自動的に追加されます（デフォルトが英語以外の場合は英語、デフォルトが英語の場合は日本語）。

使用例

対話モード

pnpm create zudo-doc

すべてデフォルトで非対話的に実行

pnpm create zudo-doc my-docs --yes

Dracula テーマの日本語サイト

pnpm create zudo-doc my-docs --lang ja --scheme Dracula --no-i18n --pm pnpm --install

カスタムスキームの Light/Dark モード

pnpm create zudo-doc my-docs \
  --color-scheme-mode light-dark \
  --light-scheme "GitHub Light" \
  --dark-scheme "GitHub Dark" \
  --default-mode dark \
  --yes

プリセットファイルの使用

セットアッププリセットジェネレーターで JSON プリセットを生成し、ファイルに保存してから CLI に渡します:

pnpm create zudo-doc --preset setup.json --install

標準入力から JSON を直接パイプすることもできます:

cat setup.json | pnpm create zudo-doc --preset - --install

CI/自動化での使用

pnpm create zudo-doc my-docs \
  --lang en \
  --scheme Nord \
  --no-i18n \
  --search \
  --no-claude-resources \
  --pm pnpm \
  --install \
  --yes

プログラム API

パッケージはプログラム API もエクスポートしています。オプションオブジェクトは JSON プリセットと同じフィールドに加え、install オプションを受け付けます:

import { createZudoDoc } from "create-zudo-doc";

await createZudoDoc({
  projectName: "my-docs",
  defaultLang: "en",
  colorSchemeMode: "light-dark",
  lightScheme: "GitHub Light",
  darkScheme: "GitHub Dark",
  defaultMode: "dark",
  respectPrefersColorScheme: true,
  features: [
    "search",
    "sidebarFilter",
    "sidebarResizer",
    "sidebarToggle",
    "docHistory",
    "footerCopyright",
  ],
  packageManager: "pnpm",
  install: true,
});