Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

README.md

Documentation Generator Scripts

[!NOTE] These scripts were generated and are maintained by an AI coding assistant.

These Lua scripts parse Lua Language Server (LuaLS) type annotations/definitions and generate Markdown documentation suitable for VitePress.

Script Overview

  • generate-docs.lua: The main driver script. It scans a source directory for type definition files (.lua or .d.lua), parses their type annotations, renders individual Markdown API files, and compiles a consolidated types.md file containing type aliases and especs.
  • luals-type-parser.lua: Parses LuaLS type annotations, extracting classes, functions, aliases, parameters, return types, and descriptions.

Running Locally

You can run the generator locally using luajit (or standard lua).

Usage

lua scripts/generate-docs.lua <types> <output>
  • <types>: Path to LuaLS type files (e.g. types/).
  • <output>: Path to the documentation folder (e.g. docs/src/x).