Installation

DocuBook Flame requires Bun >= 1.1.0. It is a Bun-native framework and does not support Node.js.

Quick Setup

1. 1
   Install dependency
   bun

   CopyReady to copy code

   mkdir my-docs && cd my-docs
   bun add @docubook/flame
   

2. 2
   Scaffold project structure

   Creates docs/, docu.json, package.json.

   bun

   CopyReady to copy code

   bunx flame init
   

3. 3
   Start dev server

   Open http://localhost:3000 in your browser.

   bun

   CopyReady to copy code

   bun run dev
   

CLI Reference

flame dev        # Start development server with HMR
flame build      # Build for production
flame preview    # Preview production build
flame deploy     # Build + prepare for GitHub Pages
flame init       # Scaffold a new project
flame clean      # Clean build artifacts
flame --help     # Show all commands

Scaffolded projects have these scripts in package.json:

{
  "scripts": {
    "dev": "flame dev",
    "build": "flame build",
    "preview": "flame preview",
    "deploy": "flame deploy"
  }
}

Global Installation

bun add -g @docubook/flame
flame init
flame dev

Requirements

• Bun >= 1.1.0