zudo-doc
GitHub repository

Type to search...

to open search from anywhere

Introduction

Created Mar 11, 2026Updated Jun 20, 2026Takeshi Takatsudo

Learn what zudo-doc is, its features, and how it works.

Welcome to zudo-doc — a documentation base framework built with zfb 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 — zfb-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 (Preact islands only where needed)

  • i18n ready — English and Japanese routing built in

  • 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

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 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 16-color palette. By swapping a single color scheme, the entire site's appearance changes.

Quick Start

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 guide for all CLI options and setup details.

Want to explore the full project?

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

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

Revision History

Takeshi TakatsudoCreated: 2026-03-11T22:32:04+09:00Updated: 2026-06-20T07:18:27Z

AI Assistant

Ask a question about the documentation.