LuauDocsNo tags. Real types. One command.

No tags just your code ​

local State = require("@self/State")
local Util = require("@self/Util")

--[[ A tiny reactive state library. ]]
local Flux = {}

Flux.State = State
Flux.Util = Util

--[[ Reports whether `value` is a state. ]]
Flux.isState = State.isState

--[[
Creates a state holding `initial`.

Call the state to read it, and see [State:Connect] for reacting to changes.
]]
function Flux.state<T>(initial: T?): State.State<T>
	return State.new(initial)
end

return Flux

LuauDocs parses your module and symbolically evaluates its top-level return statement. Everything reachable from that return value becomes your public API reference, while local helpers and _-prefixed members stay private automatically.

Real types linked everywhere ​

Flux.state<T>(initial: T?): State.State<T>

Flux.isState(value: any): boolean

Signatures come straight from your Luau annotations, so you never duplicate parameter or return types in @param and @return tags. Referenced types link to their declarations, [State:Connect] resolves to its method entry, and behavioral badges like Yields and Server are inferred from your code.

One command for humans and agents ​

## Flux

- [Flux](examples/Flux/init.luau): A tiny reactive state library.
- [`Flux.State: State`](examples/Flux/State.luau): [Module]
- [`Flux.state<T>(initial: T?): State.State<T>`](examples/Flux/init.luau#L18-L20): Creates a state holding `initial`.
- [`Flux.isState(value: any): boolean`](examples/Flux/State.luau#L20-L22): [from State] Reports whether `value` is a state.

Run luaudocs dev to preview a searchable VitePress site with live reload, or luaudocs llms to write a compact llms.txt index linking every guide and public symbol to its file:line declaration. For custom tooling, run luaudocs build --model model.json to export your full API as JSON.

Batteries Included ​

LuauDocs handles the full documentation workflow out of the box:

• Symbolic Discovery: Evaluates your module's return value to find public functions, classes, properties, and re-exports without doc tags.
• Automatic Badges: Infers Yields, Server, Client, Plugin, and Read Only badges directly from function bodies, RunService guards, and table.freeze.
• Linked Signatures: Reads types from your annotations and links project types, cross-site dependencies, and Roblox datatypes.
• Access-Path Navigation: Organizes the API sidebar and breadcrumbs around the expression callers write (Flux.Util.Queue) rather than folder paths.
• Moonwave Compatible: Supports all 24 Moonwave tags as overrides and migrates your existing config, guides, and static assets in one command.
• Coding Agents & JSON Model: Generates llms.txt indexes with file:line source links and exports your full API as a JSON doc model.
• Rich Guides & Embeds: Write guides with tabs, admonitions, inline highlighting, and <Frame> embeds that pull live entries from your generated API pages.

Quick Start ​

Requires Node.js 22.12 or newer. LuauDocs automatically downloads, verifies, and caches a pinned Lute binary on first run.

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

If you're migrating from Moonwave, run luaudocs init --from-moonwave before dev to convert your project in place.

Read the Getting Started guide or browse the Example API generated from examples/Flux.

Sponsors ​

LuauDocs is free and MIT-licensed. If LuauDocs is useful to you or your team, you can support its development through GitHub Sponsors or Ko-fi.