zudo-doc
GitHub リポジトリ

検索したい単語を入力

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

セットアッププリセットジェネレーター

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

create-zudo-docのセットアッププリセットを生成するインタラクティブヘルパー。

このインタラクティブツールを使って、zudo-docプロジェクトのオプションを設定し、セットアッププリセットを生成できます。出力はプログラマティックAPI用のJSON、またはターミナル用のCLIコマンドとしてコピーできます。

Project Name

Default Language

Color Scheme Mode

Color Scheme

Theme Pack

Features

Header right items

Markdown Options

Package Manager

言語

Default languageのセレクトでプライマリロケールを選び、プレフィックスのない/docs/...ルートを決めます。Additional language codesにはja, deのようなカンマ区切りの順序付きリストを入力します。空でないリストは自動的にi18nを追加し、生成プリセットの完全なadditionalLangs配列になります。日本語や1つの追加ロケールに限定されません。

単一言語のプリセットにするには空欄のままにします。空欄ではadditionalLangsが省略され、featuresi18nは追加されません。コードは小文字に正規化され、生成前に検証されます。重複、選択したデフォルトコード、パストラバーサル、区切り文字など安全でない値を入力するとインラインエラーが表示され、Generate Presetが無効になります。

生成ダイアログでは、同じハイドレーション済みフォーム状態を2つの形式で確認できます。次の簡略化したJSONはロケールフィールドに焦点を当てています。実際のプリセットには他に選択した機能も含まれます。

{
  "defaultLang": "en",
  "additionalLangs": ["ja", "de"],
  "features": ["i18n"]
}

as CLI commandチェックボックスで、対応する--lang en --additional-langs ja,de --i18nフラグをコピーできます。両方を指定した場合、CLIのリストがプリセットのリストを置き換え、追加はしません。旧来のブール値推論と明示的な--no-i18nに関する警告はi18nガイドを参照してください。

カラースキーム

ジェネレーターが同梱するカラースキームは Default LightDefault Dark の 2 つだけで、1 セットの OKLCH ランプを共有しています。Single scheme モードでは、ドロップダウンでどちらか一方を選べます。Light & Dark(トグル) モードでは、ペアリングは Default Light / Default Dark に固定されており、別のペアリングを選ぶスキームのドロップダウンはありません — あるのはデフォルトモードとシステム設定を尊重するかどうかのオプションだけです。

この 2 つの出発点を超えてパレットをカスタマイズするには、スキャフォールド後に自作の colorSchemes 上書きモジュール(独自のランプとセマンティックマップを持つ)を作成し、zfb.config.tscolorSchemes フィールドで渡します — カスタムカラースキームの追加 を参照し、Design Token Panel の Palette タブで変更をライブプレビューできます(カラースキームプレビューを参照)。

ヘッダー右側アイテム

「Header right items」セクションは headerRightItems フィールド — サイトヘッダー右側のクラスタ(テーマ切替、言語スイッチャー、バージョンスイッチャー、GitHub リンク、Design Token Panel / AI Chat トリガー)を構成します。各アイテムのオン・オフを切り替え、上下ボタンで描画順を変更できます。

2 種類のアイテム — link(任意の外部リンク)と html(生 HTML)— は、意図的に UI に出していません。これらを使う場合はスキャフォールド後に zfb.config.ts を直接編集してください。discriminated union のスキーマと使用例は ヘッダー右側アイテム を参照してください。

メタタグ

「Meta tags」セクションは metaTags フィールド — 各ページの <head> に出力されるメタタグを設定します。設定できる項目は以下のとおりです。

  • SEO description meta<meta name="description"> を出力します。デフォルトでオン。

  • Keywords — カンマ区切りのキーワードリストを持つ <meta name="keywords"> を出力します。デフォルトでオフ。有効にするとテキスト入力欄が表示されます。

  • OGP image (og:image)og:image(と twitter:image)を出力します。デフォルトでオフ。有効にするとパス入力欄(デフォルト /img/ogp.png)が表示されます。

  • og:site_nameog:site_name を出力します。デフォルトでオン。

  • Twitter cardtwitter:card ブロックを出力します。デフォルトでオフ。有効にするとカードタイプ選択(summary / summary_large_image)とオプションの twitter:site / twitter:creator ハンドル入力欄が表示されます。

og:title は常に出力され、ここには表示されません — DocHead の契約であり、この設定では無効化できません。

その他の機能

Features セクションには、以下の機能もあります。

  • Image enlarge — コンテンツ画像のクリック拡大。デフォルトで有効。

  • Tag governance — タグの語彙ルール監査。詳細は タグガバナンス

  • Body foot util area — 記事本文の末尾にタグリストやフィードバックリンクなどのユーティリティを差し込めるスロット。詳細は Body foot util area

  • Footer taglist — サイトフッターにグローバルタグクラウドを表示します。詳細は Footer taglist

  • Design Token Panel — スペーシング・フォント・サイズ・カラーの各トークンを編集するタブ型パネル。設定キーは designTokenPanel

  • Avoid robots indexingnoindex: trueを設定し、すべてのページに<meta name="robots" content="noindex, nofollow">を出力し、robots.txtDisallow: /を返すようにします。詳細はロボットインデックス回避を参照してください。

Revision History

Takeshi Takatsudo作成: 2026-03-26T20:56:32+09:00更新: 2026-08-31T16:30:01+09:00

AI Assistant

Ask a question about the documentation.

Preview theme

Loading theme previews…