Skip to content

LuauDocsStop writing docs.
Start generating them.

Point it at a Luau library and get a cross-linked API reference: no tags, no config, nothing to install but Node.

LuauDocs

No tags. No config. โ€‹

examples/Flux/init.luau
luau
--[[
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

state

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

Creates a state holding initial.

Call the state to read it, and see State:Connect for reacting to changes.

Nothing in that frame is hand-written. The signature comes from the Luau annotations, State.State links to the type's own page, and the [State:Connect] reference resolves into a link. This is real generated markdown, embedded directly into this page from examples/Flux.

Browse the whole example reference ยท Get started