Welcome to **zudo-doc** — a documentation base framework built with zfb and MDX.

[Dynamic content unavailable in text export]

zudo-doc is designed to be simple and extensible. Start with the basics and add features as you need them.



## Why zudo-doc?

- **Fast dev server** — zfb-powered, pages compile on demand with instant HMR
- **MDX support** — write documentation with JSX components embedded in Markdown
- **zudo-wind** — utility-first styling with a tight design token system
- **Color scheme support** — themeable ramp-based palette (base + accent + state colors) with light and dark defaults
- **Static export** — generates pure HTML, zero JS by default (client islands only where needed)
- **i18n ready** — configure any number of locale routes and content trees
- **llms.txt** — auto-generated AI-consumable documentation files
- **Versioning** — maintain multiple documentation versions with version-prefixed URLs
- **Minimal base** — extend with your own components and layouts

[Dynamic content unavailable in text export]

If you're coming from Docusaurus, you'll find the MDX workflow familiar but with a lighter footprint and full control over the design system.



## How It Works

zudo-doc uses zfb's content collections (configured in `zfb.config.ts`) to manage documentation pages. Each `.mdx` file in `src/content/docs/` becomes a page with automatic sidebar navigation, table of contents, and prev/next links.

The color scheme system uses a ramp-native palette (shared base/accent/state ramps resolved to semantic roles). By swapping a single color scheme, the entire site's appearance changes.

## Quick Start

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

Then open http://localhost:4321 to see your docs. See the [Installation](https://zudo-doc.takazudomodular.com/docs/getting-started/installation) guide for all CLI options and setup details.

[Dynamic content unavailable in text export]

If you want to explore the full project including these showcase docs, clone the repository directly instead:

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