https://github.com/l3mon4d3/luals-mdgen
Generate documentation in markdown from LuaCATS-annotations
https://github.com/l3mon4d3/luals-mdgen
Last synced: 3 months ago
JSON representation
Generate documentation in markdown from LuaCATS-annotations
- Host: GitHub
- URL: https://github.com/l3mon4d3/luals-mdgen
- Owner: L3MON4D3
- Created: 2025-05-06T10:58:41.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-06-24T22:48:37.000Z (4 months ago)
- Last Synced: 2025-08-10T19:47:00.730Z (3 months ago)
- Language: Lua
- Size: 80.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# Usage
Generate documentation in markdown from a templated markdown file and
LuaCATS-annotations.
```bash
# generate documentation (do whenever the source has changed).
emmylua_doc_cli -f json -i test_project -o ./
nvim --clean --headless -l mdgen.lua
```
For an example see the input in [`DOC-template.md`](https://github.com/L3MON4D3/luals-mdgen/blob/main/DOC-template.md?plain=1) and [`test_project/project.lua`](https://github.com/L3MON4D3/luals-mdgen/blob/main/test_project/project.lua) and the result in [`DOC.md`](https://github.com/L3MON4D3/luals-mdgen/blob/main/DOC.md).