fumablox

Install

Put fumablox in front of a Fumadocs site in a few minutes.

Fumablox writes MDX. Fumadocs renders it. You can scaffold both at once, or drop the generator into a site you already have.

Install the CLI

npm install -D @metricsrb/fumablox

Node 18.18+ is required.

Scaffold the site

npx fumablox init
npm install

init copies a Fumadocs starter and writes fumablox.toml if you do not already have Moonwave config.

Point it at Luau

Put library code in src/ or lib/, or set code yourself:

fumablox.toml
title = "MyLibrary"
code = ["src"]
outDir = "content/docs/api"

Generate, then run the site

npx fumablox generate
npm run dev

API pages land in content/docs/api. Guides stay in content/docs. Restart is not required for MDX in dev — generate again when Lua changes, or run fumablox dev to watch.

Existing Fumadocs projects

Skip init. Install @metricsrb/fumablox, set outDir to your docs folder (usually content/docs/api), and add that folder to content/docs/meta.json.

Layout

index.mdx
install.mdx
index.mdx
Aircraft.mdx
graph.mdx
fumablox.toml
Aircraft.luau

On this page