Configuration
fumablox.toml, with moonwave.toml as a drop-in.
Look for fumablox.toml, then moonwave.toml. Unknown Moonwave keys ([docusaurus], [footer], …) are ignored.
title = "MyLibrary"
description = "A Lua library"
gitRepoUrl = "https://github.com/org/MyLibrary"
gitSourceBranch = "main"
code = ["src"]
outDir = "content/docs/api"
jsonOut = "api.json"
inferUndocumented = true
minCoverage = 80
showPrivate = false
strictParams = false
robloxLinks = true
projectFile = "default.project.json"
apiCategories = ["constructor"]
[[classOrder]]
section = "Core"
classes = ["Signal", "Aircraft"]
[[classOrder]]
section = "Simulation"
classes = ["FlightController", "Engine"]Paths in the file are resolved relative to the config, so --config path/to/fumablox.toml still finds src/ next to that file.
Options
Prop
Type
Git title, repo URL, and branch fill in when omitted. .lua and .luau are both collected; Packages, _Index, and node_modules are skipped.