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 Bun, scaffold with flame init,
and start the dev server before continuing.
Project Structure
After flame init, your project looks like:
my-docs/
├── docs/
│ ├── index.mdx # Home page
│ └── guide/
│ └── index.mdx # Example section
├── docu.json # Site configuration
├── package.json # Dependencies
└── .gitignore
Add Content
Create a new file docs/getting-started.mdx:
---
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.
Edit docu.json to set your site title, navigation menu, and theme:
{
"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"
}
}
Build & Deploy
bun run build
bun run preview
bun run deploy