Fumablox

A documentation and developer-tooling platform for Luau.

Fumadocs is the presentation layer. The product is a compiler: Luau source becomes a semantic model, and that model drives the API reference, search, graphs, validation, coverage, and API diffs.

                    ┌── API reference (Fumadocs MDX)
                    │
Luau ──► parser ────┼── search
                    │
                    ├── require() graphs
                    │
                    ├── API diff
                    │
                    └── check / coverage

MDX ───────────────────► guides / tutorials

You should not have to write a function twice — once in Luau and again in Markdown. Comments enrich the model; they are not the only source of truth.

What it understands

From source, not only from tags:

• classes / modules / returned tables
• methods, functions, properties, events
• export type table types (Takeoff: (self: Aircraft) -> () is a method)
• type aliases, string-union enums, constants
• generics and Luau signatures
• require() edges and circular dependencies
• wally.toml / wally.lock (packages linked, not mirrored)
• game:GetService(...), remotes, Rojo Explorer hierarchy
• Moonwave-compatible --- / --[=[ comments when you want descriptions, examples, and realms

So this:

export type Aircraft = {
    altitude: number,
    speed: number,
    Takeoff: (self: Aircraft) -> (),
}

function Aircraft:Takeoff()
end

becomes an API page with properties, methods, and source links — even if you never wrote @param.

Install

npm install -D @metricsrb/fumablox

npx fumablox init
npx fumablox generate
npm run dev

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

Then: generate, dev, check, coverage, graph, search, diff, extract.

Source: github.com/metricrb/fumablox. Docs: metricrb.github.io/fumablox.

License

MIT