はじめに

zudo-doc とは何か、その機能、そしてどのように動作するかを学びましょう。

zudo-doc へようこそ — zfbとMDXで構築されたドキュメントベースフレームワークです。

なぜ zudo-doc？

• 高速な開発サーバー — zfb搭載、ページはオンデマンドでコンパイルされ、インスタントなHMRが利用できます

• MDXサポート — Markdown に JSX コンポーネントを埋め込んでドキュメントを記述できます

• Tailwind CSS v4 — 緻密なデザイントークンシステムを備えたユーティリティファーストのスタイリング

• カラースキーム対応 — ライトとダークのデフォルトを備えた、テーマ設定可能な16色パレット

• 静的エクスポート — 純粋なHTMLを生成、デフォルトでJSゼロ（必要な箇所のみ Preact アイランド）

• i18n 対応 — 英語と日本語のルーティングを標準搭載

• llms.txt — AI利用可能なドキュメントファイルを自動生成

• バージョニング — バージョンプレフィックス付きURLで複数バージョンのドキュメントを管理

• 最小限のベース — 独自のコンポーネントやレイアウトで拡張可能

仕組み

zudo-doc は zfb のコンテンツコレクション（zfb.config.ts で設定）を使ってドキュメントページを管理します。src/content/docs/ 内の各 .mdx ファイルは、自動的なサイドバーナビゲーション、目次、前後ページリンクを備えたページになります。

カラースキームシステムは16色パレットを使用します。単一のカラースキームを差し替えるだけで、サイト全体の見た目が変わります。

クイックスタート

pnpm create zudo-doc my-docs
cd my-docs
pnpm install
pnpm dev

http://localhost:4321 を開いてドキュメントを確認してください。CLIのオプションやセットアップの詳細はインストールガイドをご覧ください。

git clone https://github.com/zudolab/zudo-doc.git my-docs cd my-docs pnpm install pnpm dev