Compile MarkdownDeploy anything

A modern toolkit for documentation that fits your stack.

No runtime, no server to run, no lock-in. One markdown format, readable by humans and agents alike, compiled to flat static HTML — deploy anywhere.

Open source. MIT licensed. Yours.
01 / Plain text → published docs
index.mdMarkdown
  1. 1---
  2. 2title: Introduction
  3. 3description: Flame is a build-time bridge, not a runtime.
  4. 4---
  5. 5
  6. 6## Why Flame Exists
  7. 7
  8. 8Flame takes a different approach: it is **not a runtime**.
  9. 9It compiles Markdown into flat static HTML.
  10. 10
  11. 11:::info{title="Contribute"}
  12. 12 Want to contribute? Visit our [GitHub repository](/gh).
  13. 13:::
  14. 14
  15. 15## v2 Direction: Write Markdown, Not JSX
  16. 16
  17. 17Content is **plain markdown** — common markdown and directives.
your-docs / index.html✓ built

Introduction

Flame is a build-time bridge, not a runtime.

Why Flame Exists

Flame takes a different approach: it is not a runtime. It compiles Markdown into flat static HTML.

v2 Direction: Write Markdown, Not JSX

Content is plain markdown — common markdown and directives.

index.md → index.html
CommonMark + directives. Flat HTML out.
Build-time freedom

Your toolchain. Your choice.

  • Bun
  • Node.js
  • Deno
At deploy time? None.

The generated site needs no runtime or server process.

02 / A shorter path to publish

A file. A compiler. The whole web.

No platform between your words and your readers. Just a straightforward path from source to site.

  1. 01 / Authorindex.md

    Write Markdown

    CommonMark and directives. Content you can read, edit, and keep in your repository.

  2. 02 / Compile.md → .html

    Let Flame build

    DocuBook Flame compiles your documentation into flat static HTML files.

  3. 03 / Deploystatic host

    Choose your host

    Publish the generated files wherever you serve a static website.

  4. 04 / Readyour-docs.com

    Open in a browser

    Documentation, delivered. No application server to keep running.

03 / Extend without forking

Extend the build. Keep the core.

Sitemaps, analytics, reading time, custom transforms. Plugins attach to the build pipeline and dev server through hooks, so you never patch Flame itself. Zero plugins means zero behavior change.

  1. 01 / Configure

    Register in docu.json

    Add a plugins array: an npm package, a factory with options, or a local file in plugins/.

  2. 02 / Setup

    Write a setup function

    A plugin is a name and a setup(build) call. Register only the hooks you need.

  3. 03 / Hook

    Hook the pipeline

    onStart, transformFrontmatter, injectHead, transformHtml, onEnd. They run in docu.json order.

  4. 04 / Ship

    Share or keep local

    Keep it in your project or publish to npm. Hooks run on Bun, Node and Deno.

04 / Built for the work between builds

Less friction. More flow.

Small toolchain. Real control.
Built in theme

Your docs.
Your design language.

Pick a preset or set one brand color. Light and dark palettes follow, no CSS to hand-craft.

ONE COLOR. A WHOLE THEME.
Fast builds + HMR

Stay in the edit.

A fast build loop and hot module replacement keep local development moving.

$ bun run dev✓  Ready for changes↳  Edit. Save. Keep writing.
05 / Algolia integration

Good answers deserve
to be found.

Connect Algolia for full-text search. Help readers find the right page, not another dead end.


Deploy a static siteGuides / Deployment
Understanding the build outputGuides / Deployment
FULL-TEXT SEARCH WITH ALGOLIA
06 / From zero to docs

Three commands.
One fresh start.

Install Flame, initialize your project, and start the development server. Your next page starts here.

Read the getting started guide
  1. # 01 Install the compiler$ bun add @docubook/flame
  2. # 02 Initialize your documentation$ bunx flame init
  3. # 03 Start developing$ bun run dev
Local development uses a runtime. Your published HTML doesn’t.

Output / Just files
your-built-docs/├─ index.html├─ quickstart.html├─ guides.html└─ assets/
  • A static hosting serviceUpload your HTML
  • Your own infrastructureServe the same files
07 / Hosting is your call

Keep the docs.
Lose the lock-in.

Flame’s job ends at the build. The output is flat static HTML, ready for a static host or your own infrastructure. No DocuBook server to deploy. No platform to stay on.

  • Portable files
  • No server process
08 / Open by default

Open source.
Not a walled garden.

An open-source alternative to Mintlify or GitBook. Read the code, open an issue, or help shape what comes next. DocuBook is MIT licensed — and built in the open.

DocuBook / docubook

A markdown-first documentation framework.
Human-readable source. Flat static output.

20 stars5 forksMIT license

github.com/DocuBook/docubook

Less platform. More publishing.

Write like a document. Keep plain Markdown. Ship a docs site.