Skip to main content

Documentation (Moonwave)

API pages are generated from Moonwave comments in src/.

Local preview​

npm i -g moonwave@latest
moonwave dev

Build​

moonwave build

Publish to GitHub Pages​

moonwave build --publish

Or push to main with .github/workflows/publish-docs.yml enabled and GitHub Pages set to GitHub Actions.

Writing API docs​

Use Moonwave tags in Luau sources:

--[=[
	@class MyModule
	Short description.
]=]

--[=[
	Resolves something.

	@within MyModule
	@param name string
	@return boolean
]=]
function MyModule.doThing(name: string): boolean

See the Moonwave docs.