@docubook/flame 1.7.2 → 2.0.0-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.docu/components/Context.tsx +1 -1
- package/.docu/components/Search.tsx +6 -6
- package/.docu/components/Sidebar.tsx +37 -8
- package/.docu/components/Theme.tsx +2 -2
- package/.docu/components/Toc.tsx +51 -5
- package/.docu/components/Typography.tsx +1 -1
- package/.docu/components/home/Hero.tsx +4 -4
- package/.docu/components/registry.ts +1 -1
- package/.docu/lib/build.deno.js +3 -3
- package/.docu/lib/{build.impl-TSIF3F7O.js → build.impl-WR24HDUT.js} +3 -3
- package/.docu/lib/build.node.js +3 -3
- package/.docu/lib/{chunk-HRO7ONJQ.js → chunk-2EYRWRDP.js} +66 -26
- package/.docu/lib/{chunk-PJIJEPNR.js → chunk-AJV2GEDF.js} +5 -4
- package/.docu/lib/{chunk-KMDGSD57.js → chunk-KEWRVASF.js} +3 -3
- package/.docu/lib/{chunk-B6LGUADD.js → chunk-QPF4DPZQ.js} +294 -177
- package/.docu/lib/chunk-UISOJ4RW.js +114 -0
- package/.docu/lib/{chunk-DITXUPUV.js → chunk-VPV7KP7K.js} +56 -9
- package/.docu/lib/{chunk-SPHVBXRR.js → chunk-X7KPVCDN.js} +6 -6
- package/.docu/lib/clean.js +1 -1
- package/.docu/lib/deploy.deno.js +1 -1
- package/.docu/lib/deploy.node.js +1 -1
- package/.docu/lib/preview.deno.js +5 -3
- package/.docu/lib/preview.node.js +5 -3
- package/.docu/lib/server.deno.js +6 -4
- package/.docu/lib/server.node.js +6 -4
- package/.docu/node/build.impl.ts +72 -26
- package/.docu/node/build.ts +67 -17
- package/.docu/node/client.ts +64 -27
- package/.docu/node/deploy.shared.ts +5 -5
- package/.docu/node/deploy.ts +1 -1
- package/.docu/node/hydrate.node.ts +69 -4
- package/.docu/node/hydrate.ts +50 -1
- package/.docu/node/mdx-manifest.d.ts +5 -0
- package/.docu/node/mdx.ts +103 -17
- package/.docu/node/preview.deno.ts +1 -1
- package/.docu/node/preview.impl.ts +3 -3
- package/.docu/node/preview.node.ts +1 -1
- package/.docu/node/preview.ts +2 -2
- package/.docu/node/runtime/bun.ts +28 -0
- package/.docu/node/runtime/deno.ts +34 -0
- package/.docu/node/runtime/index.ts +4 -0
- package/.docu/node/runtime/node.ts +107 -0
- package/.docu/node/runtime/types.ts +19 -0
- package/.docu/node/search-indexer.ts +3 -2
- package/.docu/node/seo.ts +2 -2
- package/.docu/node/server-routes.ts +28 -13
- package/.docu/node/server.deno.ts +1 -1
- package/.docu/node/server.impl.ts +49 -3
- package/.docu/node/server.node.ts +1 -1
- package/.docu/node/server.ts +45 -1
- package/.docu/pages/docs/[[...slug]].tsx +13 -4
- package/.docu/pages/index.tsx +1 -1
- package/.docu/styles/globals.css +29 -20
- package/README.md +7 -48
- package/bin/cli.js +25 -7
- package/package.json +7 -6
- package/template/README.md +7 -48
package/.docu/styles/globals.css
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
@import "tailwindcss";
|
|
2
|
-
@import "@docubook/
|
|
2
|
+
@import "@docubook/markdown/styles.css";
|
|
3
3
|
|
|
4
4
|
@plugin "daisyui" {
|
|
5
5
|
themes:
|
|
@@ -9,16 +9,22 @@
|
|
|
9
9
|
@plugin "@tailwindcss/typography";
|
|
10
10
|
@source "../../.docu/components";
|
|
11
11
|
@source "../../.docu/pages";
|
|
12
|
-
@source inline(
|
|
12
|
+
@source inline(
|
|
13
|
+
"breadcrumbs collapse collapse-open collapse-close collapse-arrow collapse-plus collapse-title collapse-content"
|
|
14
|
+
);
|
|
13
15
|
@source inline("modal modal-top modal-middle modal-bottom modal-box modal-backdrop");
|
|
14
16
|
@source inline("drawer drawer-end drawer-toggle drawer-side drawer-overlay drawer-content");
|
|
15
17
|
@source inline("sm:drawer-open md:drawer-open lg:drawer-open xl:drawer-open");
|
|
16
18
|
@source inline("navbar menu menu-horizontal");
|
|
17
19
|
@source inline("kbd kbd-xs kbd-sm kbd-md kbd-lg kbd-xl");
|
|
18
20
|
@source inline("toggle theme-controller toggle-xs toggle-sm toggle-md toggle-lg");
|
|
19
|
-
@source inline(
|
|
21
|
+
@source inline(
|
|
22
|
+
"toggle-primary toggle-secondary toggle-accent toggle-neutral toggle-success toggle-warning toggle-info toggle-error"
|
|
23
|
+
);
|
|
20
24
|
@source inline("input input-ghost input-xs input-sm input-md input-lg input-xl");
|
|
21
|
-
@source inline(
|
|
25
|
+
@source inline(
|
|
26
|
+
"input-primary input-secondary input-accent input-neutral input-success input-warning input-info input-error"
|
|
27
|
+
);
|
|
22
28
|
@source inline("label");
|
|
23
29
|
|
|
24
30
|
@custom-variant dark (&:is(.dark *));
|
|
@@ -43,6 +49,9 @@
|
|
|
43
49
|
--color-muted-foreground: hsl(var(--muted-foreground));
|
|
44
50
|
--color-accent: hsl(var(--accent));
|
|
45
51
|
--color-accent-foreground: hsl(var(--accent-foreground));
|
|
52
|
+
--color-primary-content: hsl(var(--primary-foreground));
|
|
53
|
+
--color-secondary-content: hsl(var(--secondary-foreground));
|
|
54
|
+
--color-accent-content: hsl(var(--accent-foreground));
|
|
46
55
|
--color-popover: hsl(var(--popover));
|
|
47
56
|
--color-popover-foreground: hsl(var(--popover-foreground));
|
|
48
57
|
--color-card: hsl(var(--card));
|
|
@@ -76,27 +85,27 @@
|
|
|
76
85
|
@layer base {
|
|
77
86
|
:root {
|
|
78
87
|
--base-100: 100% 0 0;
|
|
79
|
-
--base-200:
|
|
80
|
-
--base-300:
|
|
81
|
-
--base-content:
|
|
82
|
-
--background:
|
|
88
|
+
--base-200: 97% 0.002 260;
|
|
89
|
+
--base-300: 92% 0.004 260;
|
|
90
|
+
--base-content: 22% 0.03 260;
|
|
91
|
+
--background: 0 0% 100%;
|
|
83
92
|
--foreground: 220 30% 15%;
|
|
84
93
|
--card: 0 0% 100%;
|
|
85
94
|
--card-foreground: 220 30% 15%;
|
|
86
95
|
--popover: 0 0% 100%;
|
|
87
96
|
--popover-foreground: 220 30% 15%;
|
|
88
97
|
--primary: 210 81% 56%;
|
|
89
|
-
--primary-foreground:
|
|
90
|
-
--secondary: 210
|
|
98
|
+
--primary-foreground: 210 40% 98%;
|
|
99
|
+
--secondary: 210 20% 94%;
|
|
91
100
|
--secondary-foreground: 220 30% 15%;
|
|
92
|
-
--muted: 210 20%
|
|
93
|
-
--muted-foreground: 220 15%
|
|
101
|
+
--muted: 210 20% 94%;
|
|
102
|
+
--muted-foreground: 220 15% 38%;
|
|
94
103
|
--accent: 200 100% 40%;
|
|
95
|
-
--accent-foreground:
|
|
104
|
+
--accent-foreground: 200 40% 98%;
|
|
96
105
|
--destructive: 0 85% 60%;
|
|
97
|
-
--destructive-foreground:
|
|
98
|
-
--border-color: 210 20%
|
|
99
|
-
--input: 210 20%
|
|
106
|
+
--destructive-foreground: 210 40% 98%;
|
|
107
|
+
--border-color: 210 20% 88%;
|
|
108
|
+
--input: 210 20% 88%;
|
|
100
109
|
--ring: 210 81% 56%;
|
|
101
110
|
--radius: 0.5rem;
|
|
102
111
|
}
|
|
@@ -113,15 +122,15 @@
|
|
|
113
122
|
--popover: 225 18% 14%;
|
|
114
123
|
--popover-foreground: 210 20% 93%;
|
|
115
124
|
--primary: 210 100% 67%;
|
|
116
|
-
--primary-foreground:
|
|
125
|
+
--primary-foreground: 210 0% 10%;
|
|
117
126
|
--secondary: 220 15% 18%;
|
|
118
127
|
--secondary-foreground: 210 20% 90%;
|
|
119
128
|
--muted: 220 12% 20%;
|
|
120
129
|
--muted-foreground: 215 12% 58%;
|
|
121
130
|
--accent: 200 100% 62%;
|
|
122
|
-
--accent-foreground:
|
|
131
|
+
--accent-foreground: 200 0% 10%;
|
|
123
132
|
--destructive: 0 80% 65%;
|
|
124
|
-
--destructive-foreground: 0 0%
|
|
133
|
+
--destructive-foreground: 0 0% 10%;
|
|
125
134
|
--border-color: 220 10% 28%;
|
|
126
135
|
--input: 220 10% 28%;
|
|
127
136
|
--ring: 210 100% 67%;
|
|
@@ -195,7 +204,7 @@
|
|
|
195
204
|
}
|
|
196
205
|
|
|
197
206
|
.rehype-code-title {
|
|
198
|
-
@apply -mb-8
|
|
207
|
+
@apply mt-5 -mb-8 w-full px-2 pb-5 text-sm font-medium;
|
|
199
208
|
}
|
|
200
209
|
|
|
201
210
|
.highlight-comp > code {
|
package/README.md
CHANGED
|
@@ -1,19 +1,18 @@
|
|
|
1
1
|
<h1 align="center" style="font-size: 32px;">
|
|
2
2
|
DocuBook Flame 🔥
|
|
3
3
|
</h1>
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
4
|
+
|
|
5
|
+
<p align="center" style="font-size: 20px;">
|
|
6
|
+
<strong>Compile markdown. Deploy anything.</strong>
|
|
7
|
+
</p>
|
|
7
8
|
|
|
8
9
|
<p align="center">
|
|
9
|
-
|
|
10
|
+
No runtime, no server to run, no lock-in. One markdown format, readable
|
|
11
|
+
by humans and agents alike, compiled to flat static HTML — deploy anywhere.
|
|
10
12
|
</p>
|
|
11
13
|
|
|
12
14
|
---
|
|
13
15
|
|
|
14
|
-
> **Lightweight** — 📦 ~132 kB packed. No bloat, just fire.
|
|
15
|
-
|
|
16
|
-
---
|
|
17
16
|
## Quick Start
|
|
18
17
|
|
|
19
18
|
**Bun**
|
|
@@ -43,47 +42,7 @@ deno task dev
|
|
|
43
42
|
|
|
44
43
|
## Documentation
|
|
45
44
|
|
|
46
|
-
For the full documentation, please visit **[packages/flame/docs](https://github.com/DocuBook/docubook/tree/main/packages/flame/docs)** or read the
|
|
47
|
-
|
|
48
|
-
### Getting Started
|
|
49
|
-
|
|
50
|
-
| Page | Description |
|
|
51
|
-
| --------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
|
|
52
|
-
| [Welcome](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/index.mdx) | Overview and welcome to `@docubook/flame`. |
|
|
53
|
-
| [Introduction](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/introduction.mdx) | Overview of the framework. |
|
|
54
|
-
| [Installation](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/installation.mdx) | Install and scaffold your first site. |
|
|
55
|
-
| [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. |
|
|
56
|
-
| [Format text](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/format-text.mdx) | Markdown and inline styling in MDX. |
|
|
57
|
-
| [Frontmatter](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/frontmatter.mdx) | Page metadata via frontmatter. |
|
|
58
|
-
| [Themes](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/themes.mdx) | Color system, presets, and custom hex. |
|
|
59
|
-
| [Plugins](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/plugins.mdx) | Extend the build and dev pipeline. |
|
|
60
|
-
| [Deployment](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/deployment.mdx) | Deploy to static hosting with clean URLs. |
|
|
61
|
-
| [Search — Built-in](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/search/built-in.mdx) | Build-time full-text search. |
|
|
62
|
-
| [Search — Algolia](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/search/algolia.mdx) | Algolia DocSearch integration. |
|
|
63
|
-
|
|
64
|
-
### Components
|
|
65
|
-
|
|
66
|
-
| Page | Description |
|
|
67
|
-
| ------------------------------------------------------------------------------------------------- | ---------------------------------------- |
|
|
68
|
-
| [Accordion](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/accordion.mdx) | Collapsible content sections. |
|
|
69
|
-
| [Accordion Group](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/accordion-group.mdx) | Group multiple accordions. |
|
|
70
|
-
| [Button](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/button.mdx) | Action and navigation buttons. |
|
|
71
|
-
| [Card](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/card.mdx) | Compact content cards. |
|
|
72
|
-
| [Card Group](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/card-group.mdx) | Display multiple cards together. |
|
|
73
|
-
| [Code Block](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/code-block.mdx) | Code snippets with line highlighting. |
|
|
74
|
-
| [Custom Components](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/custom.mdx) | Register your own MDX components. |
|
|
75
|
-
| [File Tree](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/file-tree.mdx) | Hierarchical file structures. |
|
|
76
|
-
| [Image](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/image.mdx) | Display images in Markdown. |
|
|
77
|
-
| [Keyboard](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/keyboard.mdx) | Keyboard keys with platform styling. |
|
|
78
|
-
| [Link](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/link.mdx) | Navigation links. |
|
|
79
|
-
| [Mermaid](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/mermaid.mdx) | Mermaid.js diagrams in MDX. |
|
|
80
|
-
| [Note](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/note.mdx) | Notes, warnings, and success messages. |
|
|
81
|
-
| [Release Note](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/release-note.mdx) | Per-version update notes. |
|
|
82
|
-
| [Stepper](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/stepper.mdx) | Step-by-step instructions. |
|
|
83
|
-
| [Tables](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/tables.mdx) | GitHub-flavored tables. |
|
|
84
|
-
| [Tabs](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/tabs.mdx) | Switchable content sections. |
|
|
85
|
-
| [Tooltips](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/tooltips.mdx) | Hover info tooltips. |
|
|
86
|
-
| [Youtube](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/youtube.mdx) | Embed YouTube videos. |
|
|
45
|
+
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)
|
|
87
46
|
|
|
88
47
|
---
|
|
89
48
|
|
package/bin/cli.js
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
/* global process, console, Bun, Deno */
|
|
3
|
-
|
|
4
3
|
import { resolve, join } from "node:path";
|
|
5
4
|
import { pathToFileURL } from "node:url";
|
|
6
5
|
import { cpSync, existsSync, readFileSync, writeFileSync, renameSync } from "node:fs";
|
|
@@ -51,6 +50,23 @@ if (!COMMAND_MAP) {
|
|
|
51
50
|
|
|
52
51
|
const command = process.argv[2];
|
|
53
52
|
|
|
53
|
+
// Detect the package manager that invoked this binary. npm, pnpm, bun, and
|
|
54
|
+
// yarn set npm_config_user_agent when they run a bin; fall back to lockfiles
|
|
55
|
+
// in the target directory for direct invocations (e.g. `node bin/cli.js`).
|
|
56
|
+
function detectPkgManager(dir) {
|
|
57
|
+
const userAgent = process.env.npm_config_user_agent || "";
|
|
58
|
+
// pnpm/yarn UA strings also contain "npm/?" — match specific tools first.
|
|
59
|
+
if (/bun\//.test(userAgent)) return "bun";
|
|
60
|
+
if (/pnpm\//.test(userAgent)) return "pnpm";
|
|
61
|
+
if (/yarn\//.test(userAgent)) return "yarn";
|
|
62
|
+
if (/npm\//.test(userAgent)) return "npm";
|
|
63
|
+
if (existsSync(join(dir, "bun.lock"))) return "bun";
|
|
64
|
+
if (existsSync(join(dir, "pnpm-lock.yaml"))) return "pnpm";
|
|
65
|
+
if (existsSync(join(dir, "yarn.lock"))) return "yarn";
|
|
66
|
+
if (existsSync(join(dir, "package-lock.json"))) return "npm";
|
|
67
|
+
return "npm";
|
|
68
|
+
}
|
|
69
|
+
|
|
54
70
|
// Parse flags
|
|
55
71
|
const themeIndex = process.argv.indexOf("--theme");
|
|
56
72
|
if (themeIndex !== -1 && themeIndex + 1 < process.argv.length) {
|
|
@@ -142,16 +158,18 @@ if (command === "init") {
|
|
|
142
158
|
}
|
|
143
159
|
writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + "\n");
|
|
144
160
|
|
|
145
|
-
//
|
|
146
|
-
//
|
|
147
|
-
|
|
148
|
-
const pkgManager = runtime === "deno" ? "deno" :
|
|
161
|
+
// The shebang (#!/usr/bin/env node) hides `typeof Bun`, so the package
|
|
162
|
+
// manager is detected from the invoking tool (npm_config_user_agent) with
|
|
163
|
+
// a lockfile fallback — the next steps must match the PM the user is on.
|
|
164
|
+
const pkgManager = runtime === "deno" ? "deno" : detectPkgManager(targetDir);
|
|
149
165
|
const nextSteps = {
|
|
150
166
|
bun: " bun install\n bun run dev",
|
|
151
|
-
|
|
167
|
+
pnpm: " pnpm install\n pnpm run dev",
|
|
168
|
+
yarn: " yarn\n yarn dev",
|
|
169
|
+
npm: " npm install\n npm run dev",
|
|
152
170
|
deno: " deno task dev\n\n ⚠️ If you see a freshness error, run:\n DENO_ALLOW_NEWER=true deno task dev",
|
|
153
171
|
}[pkgManager];
|
|
154
|
-
console.log(`\n ✓ Project scaffolded!\n\n Next steps:\n${nextSteps}\n`);
|
|
172
|
+
console.log(`\n ✓ Project scaffolded!\n\n Next steps (${pkgManager}):\n${nextSteps}\n`);
|
|
155
173
|
process.exit(0);
|
|
156
174
|
} catch (err) {
|
|
157
175
|
console.error(`Failed to scaffold project: ${err.message}`);
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@docubook/flame",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "2.0.0-alpha.0",
|
|
4
4
|
"description": "A blazing-fast React + MDX framework powered by Bun, built for modern documentation experiences.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -45,6 +45,7 @@
|
|
|
45
45
|
"author-url": "https://wildan.dev",
|
|
46
46
|
"license": "MIT",
|
|
47
47
|
"dependencies": {
|
|
48
|
+
"@mdx-js/react": "^3.0.1",
|
|
48
49
|
"@tailwindcss/cli": "4.3.0",
|
|
49
50
|
"@tailwindcss/typography": "0.5.16",
|
|
50
51
|
"bun-plugin-tailwind": "^0.1.2",
|
|
@@ -54,11 +55,11 @@
|
|
|
54
55
|
"react": "^19.2.7",
|
|
55
56
|
"react-dom": "^19.2.7",
|
|
56
57
|
"unified": "^11.0.0",
|
|
57
|
-
"
|
|
58
|
-
"@docubook/
|
|
59
|
-
"@docubook/
|
|
60
|
-
"@docubook/
|
|
61
|
-
"@docubook/
|
|
58
|
+
"zod": "^4.4.3",
|
|
59
|
+
"@docubook/core": "^2.0.0-alpha.0",
|
|
60
|
+
"@docubook/themes-colors": "^2.0.0-alpha.0",
|
|
61
|
+
"@docubook/ui-react": "^2.0.0-alpha.0",
|
|
62
|
+
"@docubook/markdown": "^2.0.0-alpha.0"
|
|
62
63
|
},
|
|
63
64
|
"peerDependencies": {
|
|
64
65
|
"@sentry/bun": "^10.0.0"
|
package/template/README.md
CHANGED
|
@@ -1,19 +1,18 @@
|
|
|
1
1
|
<h1 align="center" style="font-size: 32px;">
|
|
2
2
|
DocuBook Flame 🔥
|
|
3
3
|
</h1>
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
4
|
+
|
|
5
|
+
<p align="center" style="font-size: 20px;">
|
|
6
|
+
<strong>Compile markdown. Deploy anything.</strong>
|
|
7
|
+
</p>
|
|
7
8
|
|
|
8
9
|
<p align="center">
|
|
9
|
-
|
|
10
|
+
No runtime, no server to run, no lock-in. One markdown format, readable
|
|
11
|
+
by humans and agents alike, compiled to flat static HTML — deploy anywhere.
|
|
10
12
|
</p>
|
|
11
13
|
|
|
12
14
|
---
|
|
13
15
|
|
|
14
|
-
> **Lightweight** — 📦 ~132 kB packed. No bloat, just fire.
|
|
15
|
-
|
|
16
|
-
---
|
|
17
16
|
## Quick Start
|
|
18
17
|
|
|
19
18
|
**Bun**
|
|
@@ -43,47 +42,7 @@ deno task dev
|
|
|
43
42
|
|
|
44
43
|
## Documentation
|
|
45
44
|
|
|
46
|
-
For the full documentation, please visit **[packages/flame/docs](https://github.com/DocuBook/docubook/tree/main/packages/flame/docs)** or read the
|
|
47
|
-
|
|
48
|
-
### Getting Started
|
|
49
|
-
|
|
50
|
-
| Page | Description |
|
|
51
|
-
| --------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- |
|
|
52
|
-
| [Welcome](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/index.mdx) | Overview and welcome to `@docubook/flame`. |
|
|
53
|
-
| [Introduction](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/introduction.mdx) | Overview of the framework. |
|
|
54
|
-
| [Installation](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/installation.mdx) | Install and scaffold your first site. |
|
|
55
|
-
| [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. |
|
|
56
|
-
| [Format text](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/format-text.mdx) | Markdown and inline styling in MDX. |
|
|
57
|
-
| [Frontmatter](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/frontmatter.mdx) | Page metadata via frontmatter. |
|
|
58
|
-
| [Themes](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/themes.mdx) | Color system, presets, and custom hex. |
|
|
59
|
-
| [Plugins](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/plugins.mdx) | Extend the build and dev pipeline. |
|
|
60
|
-
| [Deployment](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/deployment.mdx) | Deploy to static hosting with clean URLs. |
|
|
61
|
-
| [Search — Built-in](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/search/built-in.mdx) | Build-time full-text search. |
|
|
62
|
-
| [Search — Algolia](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/getting-started/search/algolia.mdx) | Algolia DocSearch integration. |
|
|
63
|
-
|
|
64
|
-
### Components
|
|
65
|
-
|
|
66
|
-
| Page | Description |
|
|
67
|
-
| ------------------------------------------------------------------------------------------------- | ---------------------------------------- |
|
|
68
|
-
| [Accordion](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/accordion.mdx) | Collapsible content sections. |
|
|
69
|
-
| [Accordion Group](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/accordion-group.mdx) | Group multiple accordions. |
|
|
70
|
-
| [Button](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/button.mdx) | Action and navigation buttons. |
|
|
71
|
-
| [Card](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/card.mdx) | Compact content cards. |
|
|
72
|
-
| [Card Group](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/card-group.mdx) | Display multiple cards together. |
|
|
73
|
-
| [Code Block](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/code-block.mdx) | Code snippets with line highlighting. |
|
|
74
|
-
| [Custom Components](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/custom.mdx) | Register your own MDX components. |
|
|
75
|
-
| [File Tree](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/file-tree.mdx) | Hierarchical file structures. |
|
|
76
|
-
| [Image](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/image.mdx) | Display images in Markdown. |
|
|
77
|
-
| [Keyboard](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/keyboard.mdx) | Keyboard keys with platform styling. |
|
|
78
|
-
| [Link](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/link.mdx) | Navigation links. |
|
|
79
|
-
| [Mermaid](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/mermaid.mdx) | Mermaid.js diagrams in MDX. |
|
|
80
|
-
| [Note](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/note.mdx) | Notes, warnings, and success messages. |
|
|
81
|
-
| [Release Note](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/release-note.mdx) | Per-version update notes. |
|
|
82
|
-
| [Stepper](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/stepper.mdx) | Step-by-step instructions. |
|
|
83
|
-
| [Tables](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/tables.mdx) | GitHub-flavored tables. |
|
|
84
|
-
| [Tabs](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/tabs.mdx) | Switchable content sections. |
|
|
85
|
-
| [Tooltips](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/tooltips.mdx) | Hover info tooltips. |
|
|
86
|
-
| [Youtube](https://github.com/DocuBook/docubook/blob/main/packages/flame/docs/components/youtube.mdx) | Embed YouTube videos. |
|
|
45
|
+
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)
|
|
87
46
|
|
|
88
47
|
---
|
|
89
48
|
|