Generating Docs

Olodoc creates your documents by converting your existing markdown files to html files. To convert documents to html files, enter the project root directory,

cd /var/www/myproject

and run generate command in your command line.

composer olodoc:generate

If everything went well you will get this message.

After that the generation all documentation files will be created in your /data/docs/$version/$locale folder.

- myproject
  + bin
  + config
  - data
    - docs
        - 1.0
            - en
                index.html
                index.md
                installation.md
                installation.html
            + de
  + public
  + src
  + templates
  + vendor
  .gitignore
  composer.json
  README.md

You can change your document generation folder from your olodoc html_path configuration.

/config/autoload/local.php

<?php
declare(strict_types=1);

use Laminas\ConfigAggregator\ConfigAggregator;

return [
    //
    // olodoc
    // 
    'olodoc' => [
        /*....*/
        'html_path' => '/data/docs/', // save location for your ".html" document files
        /*....*/
    ],
]