README
¶
(Ro)blox (A)PI (R)eference
The roar command generates reference pages for the Roblox Lua API.
Usage
Currently, the only subcommand is generate, which produces data and pages for
a Hugo website. Run roar help generate to see how it is used.
Directories
¶
| Path | Synopsis |
|---|---|
|
Reads the build archive format.
|
Reads the build archive format. |
|
cmd
|
|
|
roar
command
The roar command.
|
The roar command. |
|
Provides documentation data.
|
Provides documentation data. |
|
Provides structure for API dump history.
|
Provides structure for API dump history. |
|
Provides identifiers for various API object types.
|
Provides identifiers for various API object types. |
|
Provides structure for the primary API data index.
|
Provides structure for the primary API data index. |
|
Provides a queryable representation of ReflectionMetadata.
|
Provides a queryable representation of ReflectionMetadata. |
|
For executing command-line scripts.
|
For executing command-line scripts. |
Click to show internal directories.
Click to hide internal directories.