This is a command line tool to generate documentation from your Uiua libraries.
This tool is still in development and has some limitations:
- Only the declarations in
lib.uafiles are considered. If you import bindings from other files, they will not be displayed in this version. - There's only one theme available for the generated documentation.
- Can not embed images yet.
- You need to have Rust installed in your system.
- Your library must have a single
lib.uafile in the root of the project with all the declarations.
-
Install the package globally:
cargo install uiua-doc-gen
-
Open a terminal in the root of your Uiua project and run:
uiua-doc-gen --name project-name
-
The documentation will be generated in the
doc-sitefolder.
The generated website is a static site, so you can host it on GitHub Pages. To do that, follow the steps in the uiua-doc-gen-action repository.