#Requirements

• PHP 7.4 or 8 (as CLI) and Composer https://getcomposer.org/
• Daux - generator to create static html pages from markdown. See https://daux.io/
• jq - JSON processor https://stedolan.github.io/jq/
• Each handled git project must have a subfolder ./docs/ that is compatible with Daux generator

#Install Daux

Go to https://daux.io/ and follow the instructions for installation of daux, i.e. with composer.

Add the path of the bin directory, i.e. ~/.config/composer/vendor/daux/daux.io/bin/ in $PATH.

#Install generator

Extract archive anywhere.

OR

git clone https://github.com/axelhahn/multidoc-generator.git

The result in the created subdir is:

.
├── config/
|  ├── add_2_projects/
|  ├── add_2_webroot/
│  ├── overview.template.boxes.dist
│  ├── overview.template.datatable.dist
│  └── repos.cfg.dist
├── docs/
├── generate_docs.sh
└── LICENSE

#Initialize config

Go to ./config/ directory.

• copy *.dist files to a name but without .dist
  • repos.json.dist –> repos.json
  • overview.template.boxes.dist –> overview.template (remove “.boxes” too!)
• edit config file in ./config/repos.json and add the repositories here; see Configuration