Introduction
Learn what zudo-doc is, its features, and how it works.
Welcome to zudo-doc — a minimal, fast documentation framework built with Astro 5 and MDX.
📝 Note
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 — Vite-powered, pages compile on demand with instant HMR
- MDX support — write documentation with JSX components embedded in Markdown
- Tailwind CSS v4 — utility-first styling with a tight design token system
- Color scheme support — themeable 16-color palette with light and dark defaults
- Static export — generates pure HTML, zero JS by default (React islands only where needed)
- i18n ready — English and Japanese routing built in
- Minimal base — extend with your own components and layouts
💡 Tip
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 Astro’s Content Collections 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 16-color palette. By swapping a single color scheme, the entire site’s appearance changes.
Quick Start
git clone https://github.com/zudolab/zudo-doc.git my-docs
cd my-docs
pnpm install
pnpm dev
Then open http://localhost:4321 to see your docs.