DocuBook

An open-source alternative to Mintlify or GitBook. Write documentation in MDX with React. The toolchain runs on Bun, Node.js, or Deno — output is flat static HTML, no server required.

Architecture

DocuBook is a static site generator for documentation. The core pipeline compiles MDX into flat .html files. The runtime (Bun, Node.js, Deno) is only needed for the build toolchain and local dev server; the final output is pure static HTML + assets — deploy to any CDN or static host.

flowchart TD
    A[MDX Content - *.mdx]
    B["@docubook/core — compile pipeline, rehype/remark plugins"]
    C["@docubook/mdx-content — portable UI components"]
    D["@docubook/flame - Frameworks Docs"]
    RUNT["@docubook/runt — Runtime adapters"]
    D1["Bun + React - ready to use"]
    D2["Node + React - ready to use"]
    D3["Deno + React - ready to use"]
    E[Browser - *.html]

    A -->  B --> C --> D
    D --> D1 --> E
    D --> RUNT --> D2 --> E
    D --> RUNT --> D3 --> E

Loading

Packages

Package	Description
@docubook/core	Shared MDX compile pipeline, rehype/remark plugins, and markdown utilities.
@docubook/mdx-content	Portable MDX components (Mermaid, CodeBlock, Tabs, etc.) with framework-agnostic adapters.
@docubook/flame	The runtime layer — a React + MDX framework that bridges compiled content to the browser. Runs on Bun, Node.js, and Deno.
@docubook/runt	Runtime HTTP server adapters (Bun, Node.js, Deno) behind a single RuntimeAdapter interface.
@docubook/mdx-remote	Runtime MDX compilation and rendering — a rewrite of next-mdx-remote for DocuBook.

Runtimes

The runtime is only needed for the build toolchain and local dev server. The output is flat static HTML — deploy to any CDN or static host (Vercel, Netlify, Cloudflare Pages, GitHub Pages, S3, etc.).

Runtime	UI Library	Status	Recipe
Bun	React	✅ Available	bun add @docubook/flame
Node	React	✅ Available	npm install @docubook/flame
Deno	React	✅ Available	deno run -A npm:@docubook/flame init

Prerequisites

Choose one runtime to get started.

Bun (≥ 1.1.0)

# Install: https://bun.sh
curl -fsSL https://bun.sh/install | bash
# or: npm install -g bun

bun --version

Node.js (≥ 20.11)

# Install: https://nodejs.org
# or: https://github.com/nvm-sh/nvm#installing-and-updating

node --version

Deno (≥ 2.x)

# Install: https://deno.com
curl -fsSL https://deno.land/install.sh | sh
# or (macOS): brew install deno

deno --version

---

Installation

Bun + React

mkdir my-docs && cd my-docs
bun add @docubook/flame
bunx flame init
bun run dev

Node.js + React (Node >= 20.11)

mkdir my-docs && cd my-docs
npm install @docubook/flame
npx flame init
npm run dev

Deno + React

mkdir my-docs && cd my-docs
deno run -A npm:@docubook/flame init
deno task dev

Contributing

Note

We are very open to all your contributions, no matter how small your contribution is, it will certainly be part of the development of this project.

Please read: CONTRIBUTING.md

Workspace

Important

This repository uses a monorepo setup powered by pnpm workspaces and Turborepo to manage apps and packages in a single workspace.

For development workflow:

• Vitest provides fast unit testing with native ESM and TypeScript support
• Changesets handles package versioning and release management
• Husky runs automatic linting and formatting before commits
• commitlint ensures commit messages follow the Conventional Commits format consistently

This setup helps keep the codebase organized, maintainable, and contributor-friendly.