docs library

Classes

DocHtmlResult

Result of rendering documentation to HTML fragments.

DocPageOptions

Options for rendering the shared LuaLike documentation page shell.

Enums

MetadataFormat

Output format for generated metadata.

Functions

buildDocsManifest(List<Library> libraries, {String packageName = 'lualike', String? packageVersion}) → Map<String, Object?>

Builds a stable JSON-serializable manifest for editor tooling.

documentedLibrariesForRuntime(LuaRuntime runtime) → List<Library>

Initializes runtime libraries and returns them in registry order.

generateMetadata(LuaLike lua, {required String outputDir, Set<MetadataFormat> formats = const {MetadataFormat.html, MetadataFormat.json, MetadataFormat.luals}, bool includeStdlib = true, bool split = false, String? packageName, String? packageVersion, DocPageOptions? pageOptions}) → Future<void>

Generates metadata files for all libraries registered on lua.

renderDocs(List<Library> libraries) → DocHtmlResult

Renders a list of Library objects into sidebar and content HTML.

renderDocsJson(List<Library> libraries, {String packageName = 'lualike', String? packageVersion}) → String

Encodes buildDocsManifest as indented JSON for tools and editors.

renderDocsPage(List<Library> libraries, {DocPageOptions options = const DocPageOptions()}) → String

Renders the shared, complete LuaLike documentation HTML page.

renderLuaLsAnnotations(List<Library> libraries, {String packageName = 'lualike', String? packageVersion}) → String

Renders LuaLS-compatible annotation stubs for the documented libraries.