DocuBook Flame

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

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.11) — 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 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.