tealr_doc_gen-0.3.0-alpha2 is not a library.
tealr_doc_gen
This tool is meant to be used together with tealr and is used to generate online documentation for lua/teal apis created with tealr
Rendered Example
https://lenscas.github.io/tealsql/
Features:
- full markdown support
- code highlighting in code examples
- multiple theme support
- snippets marked as
teal_lua
get compiled tolua
and both versions get embedded. - When compiling
teal_lua
snippets, any errors get logged.
How to get the json
The json file needed to generate the documentation can easily be gotten using
use ;
Install
To install, simply run
cargo install tealr_doc_gen
Cargo will do the rest.
After it is installed, generating the online documentation is done by running
tealr_doc_gen --json path/to/json/file --name yourApiName
Arguments
Required arguments
--json
/path/to/json/generated/by/tealr
--name
nameOfTheLibrary
Optional arguments
--build_folder
What folder to store the generated html pages at (defaults to./pages
)--root
set if/
will not be the root of the server