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

Architecture

flowchart TD
    Author["📝 Author<br/>writes markdown (.md)"] --> Flame["DocuBook Flame 🔥<br/>compiles to flat .html"]
    Flame --> Host["📦 Static host"]
    Host -->|serves static HTML| Browser["🌐 Browser"]
    Browser -->|requests page| Host

Loading

Quick Start

Prerequisite

Warning

Verify the runtime is installed: bun --version, node --version, or deno --version.

Create the project directory, then run the flow for your runtime:

mkdir my-docs && cd my-docs

Bun (≥ 1.4.0) — install

bun add @docubook/flame
bunx flame init
bun run dev

Node.js (^20.19 or ≥ 22.12) — install

npm install @docubook/flame
npx flame init
npm run dev

Deno (≥ 2.x) — install

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; a Release PR on main publishes the linked @docubook/* packages to npm with trusted publishing (OIDC + provenance)
• Renovate keeps dependencies current: it opens grouped update PRs on Mondays once a release is 3 days old, opens vulnerability PRs on any day, and tracks everything pending in the Dependency Dashboard
• Husky runs lint-staged (Prettier + Oxlint) before commits and a lint, build and commitlint check before pushes
• commitlint ensures commit messages follow the Conventional Commits format consistently

See CONTRIBUTING.md for the full workflow, including how Renovate PRs are reviewed, and ARCHITECTURE.md for the release model.