@docubook/flame 1.7.2 → 2.0.0-alpha.1

package/README.md

@@ -1,19 +1,18 @@
 <h1 align="center" style="font-size: 32px;">
   DocuBook Flame 🔥
 </h1>
-<h3 align="center" style="font-size: 20px;">
-  Fast as flame — a Bun-native framework for modern documentation experiences.
-</h3>
+
+<p align="center" style="font-size: 20px;">
+  <strong>Compile markdown. Deploy anything.</strong>
+</p>
 
 <p align="center">
-  <strong>@docubook/flame</strong> is a lightweight runtime for building documentation websites using React, MDX, and filesystem-based routing — running on Bun, Node.js, and Deno.
+  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.
 </p>
 
 ---
 
-> **Lightweight** — 📦 ~132 kB packed. No bloat, just fire.
-
----
 ## Quick Start
 
 **Bun**
@@ -43,47 +42,7 @@ deno task dev
 
 ## Documentation
 
-For the full documentation, please visit **[packages/flame/docs](https://github.com/DocuBook/docubook/tree/main/packages/flame/docs)** or read the individual pages below:
-
-### Getting Started
-
-| Page                                                                                                                  | Description                                  |
-| --------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
-| [Welcome](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/index.mdx)                               | Overview and welcome to `@docubook/flame`.   |
-| [Introduction](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/introduction.mdx)   | Overview of the framework.                   |
-| [Installation](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/installation.mdx)   | Install and scaffold your first site.        |
-| [Quick Start Guide](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/quick-start-guide.mdx) | Get up and running in minutes.        |
-| [Format text](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/format-text.mdx)     | Markdown and inline styling in MDX.          |
-| [Frontmatter](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/frontmatter.mdx)     | Page metadata via frontmatter.               |
-| [Themes](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/themes.mdx)               | Color system, presets, and custom hex.       |
-| [Plugins](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/plugins.mdx)             | Extend the build and dev pipeline.           |
-| [Deployment](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/deployment.mdx)       | Deploy to static hosting with clean URLs.    |
-| [Search — Built-in](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/search/built-in.mdx) | Build-time full-text search.           |
-| [Search — Algolia](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/search/algolia.mdx) | Algolia DocSearch integration.         |
-
-### Components
-
-| Page                                                                                              | Description                              |
-| ------------------------------------------------------------------------------------------------- | ---------------------------------------- |
-| [Accordion](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/accordion.mdx)               | Collapsible content sections.        |
-| [Accordion Group](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/accordion-group.mdx)   | Group multiple accordions.           |
-| [Button](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/button.mdx)                     | Action and navigation buttons.       |
-| [Card](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/card.mdx)                         | Compact content cards.               |
-| [Card Group](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/card-group.mdx)             | Display multiple cards together.     |
-| [Code Block](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/code-block.mdx)             | Code snippets with line highlighting. |
-| [Custom Components](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/custom.mdx)          | Register your own MDX components.    |
-| [File Tree](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/file-tree.mdx)               | Hierarchical file structures.        |
-| [Image](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/image.mdx)                       | Display images in Markdown.          |
-| [Keyboard](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/keyboard.mdx)                 | Keyboard keys with platform styling. |
-| [Link](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/link.mdx)                         | Navigation links.                    |
-| [Mermaid](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/mermaid.mdx)                   | Mermaid.js diagrams in MDX.          |
-| [Note](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/note.mdx)                         | Notes, warnings, and success messages. |
-| [Release Note](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/release-note.mdx)         | Per-version update notes.            |
-| [Stepper](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/stepper.mdx)                   | Step-by-step instructions.           |
-| [Tables](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/tables.mdx)                     | GitHub-flavored tables.              |
-| [Tabs](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/tabs.mdx)                         | Switchable content sections.         |
-| [Tooltips](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/tooltips.mdx)                 | Hover info tooltips.                 |
-| [Youtube](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/youtube.mdx)                   | Embed YouTube videos.                |
+For the full documentation, please visit **[packages/flame/docs](https://github.com/DocuBook/docubook/tree/main/packages/flame/docs)** or read the official site [docubook.pro](https://docubook.pro)
 
 ---
 

package/bin/cli.js

@@ -1,6 +1,5 @@
 #!/usr/bin/env node
 /* global process, console, Bun, Deno */
-
 import { resolve, join } from "node:path";
 import { pathToFileURL } from "node:url";
 import { cpSync, existsSync, readFileSync, writeFileSync, renameSync } from "node:fs";
@@ -51,6 +50,23 @@ if (!COMMAND_MAP) {
 
 const command = process.argv[2];
 
+// Detect the package manager that invoked this binary. npm, pnpm, bun, and
+// yarn set npm_config_user_agent when they run a bin; fall back to lockfiles
+// in the target directory for direct invocations (e.g. `node bin/cli.js`).
+function detectPkgManager(dir) {
+  const userAgent = process.env.npm_config_user_agent || "";
+  // pnpm/yarn UA strings also contain "npm/?" — match specific tools first.
+  if (/bun\//.test(userAgent)) return "bun";
+  if (/pnpm\//.test(userAgent)) return "pnpm";
+  if (/yarn\//.test(userAgent)) return "yarn";
+  if (/npm\//.test(userAgent)) return "npm";
+  if (existsSync(join(dir, "bun.lock"))) return "bun";
+  if (existsSync(join(dir, "pnpm-lock.yaml"))) return "pnpm";
+  if (existsSync(join(dir, "yarn.lock"))) return "yarn";
+  if (existsSync(join(dir, "package-lock.json"))) return "npm";
+  return "npm";
+}
+
 // Parse flags
 const themeIndex = process.argv.indexOf("--theme");
 if (themeIndex !== -1 && themeIndex + 1 < process.argv.length) {
@@ -142,16 +158,18 @@ if (command === "init") {
     }
     writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + "\n");
 
-    // Runtime detection via shebang (#!/usr/bin/env node) makes typeof Bun
-    // unavailable — check for bun.lock as a reliable Bun indicator.
-    const isBun = existsSync(join(targetDir, "bun.lock"));
-    const pkgManager = runtime === "deno" ? "deno" : isBun ? "bun" : "node";
+    // The shebang (#!/usr/bin/env node) hides `typeof Bun`, so the package
+    // manager is detected from the invoking tool (npm_config_user_agent) with
+    // a lockfile fallback — the next steps must match the PM the user is on.
+    const pkgManager = runtime === "deno" ? "deno" : detectPkgManager(targetDir);
     const nextSteps = {
       bun: "    bun install\n    bun run dev",
-      node: "    npm install\n    npm run dev",
+      pnpm: "    pnpm install\n    pnpm run dev",
+      yarn: "    yarn\n    yarn dev",
+      npm: "    npm install\n    npm run dev",
       deno: "    deno task dev\n\n  ⚠️  If you see a freshness error, run:\n    DENO_ALLOW_NEWER=true deno task dev",
     }[pkgManager];
-    console.log(`\n  ✓ Project scaffolded!\n\n  Next steps:\n${nextSteps}\n`);
+    console.log(`\n  ✓ Project scaffolded!\n\n  Next steps (${pkgManager}):\n${nextSteps}\n`);
     process.exit(0);
   } catch (err) {
     console.error(`Failed to scaffold project: ${err.message}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docubook/flame",
-  "version": "1.7.2",
+  "version": "2.0.0-alpha.1",
   "description": "A blazing-fast React + MDX framework powered by Bun, built for modern documentation experiences.",
   "type": "module",
   "bin": {
@@ -45,6 +45,7 @@
   "author-url": "https://wildan.dev",
   "license": "MIT",
   "dependencies": {
+    "@mdx-js/react": "^3.0.1",
     "@tailwindcss/cli": "4.3.0",
     "@tailwindcss/typography": "0.5.16",
     "bun-plugin-tailwind": "^0.1.2",
@@ -54,11 +55,11 @@
     "react": "^19.2.7",
     "react-dom": "^19.2.7",
     "unified": "^11.0.0",
-    "@docubook/runt": "^1.0.0",
-    "@docubook/ui-react": "^1.0.0",
-    "@docubook/mdx-content": "^3.4.6",
-    "@docubook/themes-colors": "^1.0.2",
-    "@docubook/core": "^1.8.2"
+    "zod": "^4.4.3",
+    "@docubook/core": "^2.0.0-alpha.1",
+    "@docubook/markdown": "^2.0.0-alpha.1",
+    "@docubook/themes-colors": "^2.0.0-alpha.1",
+    "@docubook/ui-react": "^2.0.0-alpha.1"
   },
   "peerDependencies": {
     "@sentry/bun": "^10.0.0"

package/template/README.md

@@ -1,19 +1,18 @@
 <h1 align="center" style="font-size: 32px;">
   DocuBook Flame 🔥
 </h1>
-<h3 align="center" style="font-size: 20px;">
-  Fast as flame — a Bun-native framework for modern documentation experiences.
-</h3>
+
+<p align="center" style="font-size: 20px;">
+  <strong>Compile markdown. Deploy anything.</strong>
+</p>
 
 <p align="center">
-  <strong>@docubook/flame</strong> is a lightweight runtime for building documentation websites using React, MDX, and filesystem-based routing — running on Bun, Node.js, and Deno.
+  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.
 </p>
 
 ---
 
-> **Lightweight** — 📦 ~132 kB packed. No bloat, just fire.
-
----
 ## Quick Start
 
 **Bun**
@@ -43,47 +42,7 @@ deno task dev
 
 ## Documentation
 
-For the full documentation, please visit **[packages/flame/docs](https://github.com/DocuBook/docubook/tree/main/packages/flame/docs)** or read the individual pages below:
-
-### Getting Started
-
-| Page                                                                                                                  | Description                                  |
-| --------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
-| [Welcome](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/index.mdx)                               | Overview and welcome to `@docubook/flame`.   |
-| [Introduction](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/introduction.mdx)   | Overview of the framework.                   |
-| [Installation](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/installation.mdx)   | Install and scaffold your first site.        |
-| [Quick Start Guide](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/quick-start-guide.mdx) | Get up and running in minutes.        |
-| [Format text](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/format-text.mdx)     | Markdown and inline styling in MDX.          |
-| [Frontmatter](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/frontmatter.mdx)     | Page metadata via frontmatter.               |
-| [Themes](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/themes.mdx)               | Color system, presets, and custom hex.       |
-| [Plugins](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/plugins.mdx)             | Extend the build and dev pipeline.           |
-| [Deployment](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/deployment.mdx)       | Deploy to static hosting with clean URLs.    |
-| [Search — Built-in](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/search/built-in.mdx) | Build-time full-text search.           |
-| [Search — Algolia](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/search/algolia.mdx) | Algolia DocSearch integration.         |
-
-### Components
-
-| Page                                                                                              | Description                              |
-| ------------------------------------------------------------------------------------------------- | ---------------------------------------- |
-| [Accordion](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/accordion.mdx)               | Collapsible content sections.        |
-| [Accordion Group](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/accordion-group.mdx)   | Group multiple accordions.           |
-| [Button](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/button.mdx)                     | Action and navigation buttons.       |
-| [Card](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/card.mdx)                         | Compact content cards.               |
-| [Card Group](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/card-group.mdx)             | Display multiple cards together.     |
-| [Code Block](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/code-block.mdx)             | Code snippets with line highlighting. |
-| [Custom Components](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/custom.mdx)          | Register your own MDX components.    |
-| [File Tree](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/file-tree.mdx)               | Hierarchical file structures.        |
-| [Image](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/image.mdx)                       | Display images in Markdown.          |
-| [Keyboard](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/keyboard.mdx)                 | Keyboard keys with platform styling. |
-| [Link](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/link.mdx)                         | Navigation links.                    |
-| [Mermaid](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/mermaid.mdx)                   | Mermaid.js diagrams in MDX.          |
-| [Note](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/note.mdx)                         | Notes, warnings, and success messages. |
-| [Release Note](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/release-note.mdx)         | Per-version update notes.            |
-| [Stepper](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/stepper.mdx)                   | Step-by-step instructions.           |
-| [Tables](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/tables.mdx)                     | GitHub-flavored tables.              |
-| [Tabs](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/tabs.mdx)                         | Switchable content sections.         |
-| [Tooltips](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/tooltips.mdx)                 | Hover info tooltips.                 |
-| [Youtube](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/youtube.mdx)                   | Embed YouTube videos.                |
+For the full documentation, visit **[www.docubook.pro](https://www.docubook.pro/)**
 
 ---
 

package/template/docs/getting-started/configuration.mdx

@@ -3,16 +3,28 @@ title: Configuration
 description: docu.json reference — meta, navbar, themes, routes, and plugins.
 ---
 
-`docu.json` in your project root controls the site. Key sections:
+`docu.json` in the project root controls the whole site. It is validated against `docu.schema.json`.
+
+## First edits
+
+| What | Where |
+|---|---|
+| Site name & tagline | `meta.title`, `meta.description` |
+| Brand in the header | `navbar.logoText` |
+| Landing copy | `home.hero` — headline, description, actions |
+| Colour preset | `themes.colors` — `default`, `freshlime`, `coffee` |
+| Footer links | `footer.social` |
+
+## Reference
 
 | Field | Description |
 |---|---|
 | `meta` | Site title, description, favicon, base URL |
 | `navbar` | Logo, navigation menu links |
-| `home.hero` | Landing page hero with tagline, headline, actions |
-| `home.features` | Feature cards with icon, title, description |
+| `home.hero` | Landing page hero — tagline, headline, actions |
+| `home.features` | Feature cards — icon, title, description |
 | `routes` | Sidebar navigation (auto-detected from `docs/` when empty) |
 | `themes` | Colour preset or custom palette |
 | `plugins` | Build/dev pipeline extensions |
 
-See this site's `docu.json` for a complete example, or refer to `docu.schema.json` in the package root.
+This project's `docu.json` is a complete working example — edit it and the dev server applies the changes live.

package/template/docs/getting-started/overview.mdx

@@ -1,50 +1,42 @@
 ---
 title: Quick Start
-description: Get your first documentation site running on Bun, Node.js, or Deno.
+description: The Flame workflow — dev server, first edit, authoring, and build.
 ---
 
-## Prerequisites
-
-Choose **one** runtime:
-
-- **Bun** >= 1.1: `curl -fsSL https://bun.sh/install | bash`
-- **Node.js** >= 20.11: [nodejs.org](https://nodejs.org)
-- **Deno** >= 2.x: `curl -fsSL https://deno.land/install.sh | sh`
-
-## Create a project
-
-<Tabs>
-  <Tab title="Bun">
-    ```bash
-    mkdir my-docs && cd my-docs
-    bun add @docubook/flame
-    bunx flame init
-    bun run dev
-    ```
-  </Tab>
-  <Tab title="Node.js">
-    ```bash
-    mkdir my-docs && cd my-docs
-    npm install @docubook/flame
-    npx flame init
-    npm run dev
-    ```
-  </Tab>
-  <Tab title="Deno">
-    ```bash
-    mkdir my-docs && cd my-docs
-    deno run -A npm:@docubook/flame init
-    deno task dev
-    ```
-  </Tab>
-</Tabs>
-
-Open http://localhost:3000 — changes to `docs/` or `docu.json` hot-reload.
-
-## Build for production
+Your Flame project is ready — this is the workflow to make it yours.
+
+## 1. Run the dev server
+
+```bash
+bun run dev        # or: npm run dev / deno task dev
+```
+
+Open http://localhost:3000 — edits to `docs/` and `docu.json` hot-reload instantly.
+
+## 2. Make your first edit
+
+Open `docs/getting-started/overview.mdx` (this file):
+
+1. Change `title` and `description` in the frontmatter — the browser updates live
+2. Add a heading below and save
+3. New pages appear in the sidebar and search automatically
+
+## 3. Author with directives
+
+Content is plain markdown — components are directives, no JSX:
+
+```md
+:::tip
+A callout — no JSX needed.
+:::
+```
+
+See [Components](/docs/guide/components) for the full directive set.
+
+## 4. Build for production
 
 ```bash
-npm run build     # or: bun run build / deno task build
+bun run build      # or: npm run build / deno task build
 ```
 
-Static output goes to `.docu/dist/` — deploy to any CDN or static host.
+Flat static HTML lands in `.docu/dist/` — deploy anywhere ([Deployment](/docs/guide/deployment)).