LuauDocs

Documentation generator for Luau. Point it at your module root and it documents what your library exports, reading your doc comments and real type annotations to render a VitePress site.

• No tags required. LuauDocs works out what your module returns, so an untagged library still gets a full API reference, down to Yields, Server, and Client badges read from what each function actually does; tags exist only to override what the code says.
• Signatures from your real types. Every field, parameter, and return comes from the annotations already in your code, cross-linked to each type's own entry, so a rendered signature cannot drift from the thing it documents.
• Moonwave-compatible. All 24 Moonwave tags keep working as overrides, so tagged sources need no edits, and one command ports the config, the hand-written pages, and the static assets.
• Built to be built on. luaudocs build --model api.json writes your whole API as JSON, with type references resolved to the declarations they name, and every site ships llms.txt and llms-full.txt, so tooling and AI assistants read your docs as easily as people do.

Quick Start

Needs Node.js 22.12 or newer, and nothing else to install: the extractor runs on a pinned Lute build that the first run downloads, checksums, and caches for you.

npm i -g luaudocs
cd my-luau-library
luaudocs dev

Already on Moonwave? Run luaudocs init --from-moonwave before dev to convert the project in place.

Documentation

Read the docs → · Browse a generated reference →

That reference is built from examples/Flux by the same commands above, and the guides embed it inline rather than mocking it up.

License

LuauDocs is released under the MIT License.