Daux.io is a documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking documentation in a developer friendly way.
Please refer to Daux.io for more information.
Before installing Daux, you already need to have the following:
- PHP 5.5 or higher = http://php.net/
- Composer: https://getcomposer.org/ (Install and then add "~/.composer/vendor/binβ to your $PATH)
composer install
to install the required dependencies to build the project
They reside in the docs folder of this repo structured with folders and MarkDown files.
Now you can clone this repo and start writing with MarkDown.
Simply run the command bin/daux
or generate
in the root folder.
To view the generated HTML in the browser, use the serve
command and browse
to the reported URL on your browser.
Each time you build the Jet Reference Manual, its HTML output will be put into the static folder of this repo. Build process creates this folder automatically if it does not exist.