• Docs
  • Getting Started
  • Quick Start Guide

Quick Start Guide

Get up and running with @docubook/flame in minutes.

Welcome to @docubook/flame! This guide walks you through creating your first documentation site.

Prerequisites & Setup

Follow the installation guide to install Flame, scaffold with flame init, and start the dev server before continuing.

Project Structure

After flame init, your project looks like:

text
my-docs/
├── docs/
│   ├── index.mdx          # Home page (optional)
│   └── guide/
│       └── index.mdx      # Example section
├── docu.json               # Site configuration
├── package.json            # Dependencies
└── .gitignore

On Deno, an additional deno.json is generated with nodeModulesDir: "auto".

The landing page always owns / and docs/index.mdx is optional — without it the build simply has no docs index page. Where the docs live in URLs and in the build output comes from meta.basePath (default /docs) — see Base Path & Subpaths.

Add Content

Create a new file docs/getting-started.mdx:

markdown
---
title: Getting Started
description: Your first steps with Flame.
---

Welcome! This page is auto-discovered from the filesystem.

No route configuration needed — Flame scans docs/ and generates the sidebar automatically.

Configure Your Site

Edit docu.json to set your site title, navigation menu, and theme:

json
{
  "meta": {
    "title": "My Docs",
    "description": "Documentation powered by DocuBook Flame",
    "baseURL": "https://example.com"
  },
  "navbar": {
    "logoText": "My Docs",
    "menu": [
      { "title": "Home", "href": "/" },
      { "title": "Docs", "href": "/docs" }
    ]
  },
  "themes": {
    "colors": "default"
  }
}

See the Configuration reference for all available options. meta.basePath defaults to /docs; set it to serve the docs under a different prefix, or to "" to serve them from the deployment root.

Build & Deploy

bash
bun run build      # Static build to .docu/dist/
bun run preview    # Preview the built output
bun run deploy     # Build + prepare for GitHub Pages

The output is a fully static site in .docu/dist/ — no server runtime required. Deploy to any CDN or static host.

Edit this page

Last updated Sep 24, 2026