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

[Dynamic content unavailable in text export]

zudo-doc はシンプルかつ拡張可能であるように設計されています。基本から始めて、必要に応じて機能を追加していけます。



## なぜ zudo-doc？

- **高速な開発サーバー** — zfb搭載、ページはオンデマンドでコンパイルされ、インスタントなHMRが利用できます
- **MDXサポート** — Markdown に JSX コンポーネントを埋め込んでドキュメントを記述できます
- **zudo-wind** — 緻密なデザイントークンシステムを備えたユーティリティファーストのスタイリング
- **カラースキーム対応** — ライトとダークのデフォルトを備えた、テーマ設定可能なランプベースのパレット（base + accent + state カラー）
- **静的エクスポート** — 純粋なHTMLを生成、デフォルトでJSゼロ（必要な箇所のみ クライアントアイランド）
- **i18n 対応** — 任意の数のロケールルートとコンテンツツリーを設定可能
- **llms.txt** — AI利用可能なドキュメントファイルを自動生成
- **バージョニング** — バージョンプレフィックス付きURLで複数バージョンのドキュメントを管理
- **最小限のベース** — 独自のコンポーネントやレイアウトで拡張可能

[Dynamic content unavailable in text export]

Docusaurus から移行してくる場合、MDX ワークフローに馴染みを感じつつ、より軽量なフットプリントとデザインシステムへの完全なコントロールを得られます。



## 仕組み

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

カラースキームシステムはランプネイティブなパレット（共有される base/accent/state ランプをセマンティックロールへ解決します）を使用します。単一のカラースキームを差し替えるだけで、サイト全体の見た目が変わります。

## クイックスタート

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

http://localhost:4321 を開いてドキュメントを確認してください。CLIのオプションやセットアップの詳細は[インストール](https://zudo-doc.takazudomodular.com/ja/docs/getting-started/installation)ガイドをご覧ください。

[Dynamic content unavailable in text export]

ショーケースドキュメントを含むフルプロジェクトを確認したい場合は、リポジトリを直接クローンしてください：

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