Fir is a language-agnostic documentation generator framework. It is fully modular, which means you can mix a comment extractor with a different comment parser and emitter (but you aren't going to go through the hassle of writing anything). A set of generic modules for generating Markdown documentation is provided, don't expect much more (unless you press me to write more).
You can install Fir via LuaRocks:
$ luarocks install fir
If you want to compile from source, you will need to install the following dependencies from LuaRocks:
argparse
(CLI)ansikit
(CLI, optional if using CLI with--silent
)filekit
(Library, CLI)moonplus
(Compiling)alfons
(Compiling)rockbuild
(Compiling)
Then, simply run alfons compile make -v 1.0
. To clean the project, simply alfons clean
.
Check out the documentation here.
I kindly welcome new features that anyone wants to suggest or add! Feel free to open an issue or PR.
This project is Unlicensed, and released to the public domain. Do whatever you wish with it!