Want to be notified of new releases in dauxio/daux.io?
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.
ICADMIN: An admin panel powered by CodeIgniter.
Do you use Daux.io? Send me a pull request or open an issue and I will add you to the list.
You can then use the daux command line to generate your documentation.
Download this repository as a zip, unpack, and put your documentation in the docs folder, you can then serve it with Apache or Nginx.
The command line tool has two commands: generate and serve, running Daux.io without an argument will automatically run the generate command.
You can run daux --help to get more details about each command.
By default, the generator will look for folders in the docs folder. Add your folders inside the docs folder. This project contains some example folders and files to get you started.
You can nest folders any number of levels to get the exact structure you want. The folder structure will be converted to the nested navigation.
If you'd prefer to keep your docs somewhere else (like outside of the daux.io root directory) you can specify your docs path in the global.json file.
The generator will look for Markdown files (*.md and *.markdown) inside the docs folder and any of the subfolders within docs.
Note: The image can be a local or remote image. Use the convention <base_url> to refer to the root directory of the Daux instance.
To customize the look and feel of your documentation, you can create a config.json file in the of the /docs folder. The config.json file is a simple JSON object that you can use to change some of the basic settings of the documentation.
Copy the files from the repo to a web server that can run PHP 5.4 or greater.
There are several ways to run the docs locally. The recommended way is to run daux serve which will execute PHP's embedded server.
This is really only intended be used when you are writing/updating a ton of docs and want to preview the changes locally.
A docker configuration is also provided to run daux within a container, you can either run daux with php5 or php7.
Daux.io is compatible with PHP 7.1.3 and up.
The reason is because some dependencies we have (mainly Symfony and Guzzle) do not support PHP 5.6 anymore.
PHP Needs the following extension to work : php-mbstring and php-xml.
If you encounter an error similar to utf8_decode() not found this means that you're missing the php-xml package.
If you need help using Daux.io, or have found a bug, please create an issue on the GitHub repo.