macfly/yii2-markdown-doc

Yii2 module to expose identity and rbac through a restful API

yii2-markdown-doc

Yii2 module to display the content of all markdown file in a directory and its sub-folder., _(*1)

Installation

The preferred way to install this extension is through composer., _(*2)

Either run, _(*3)

php composer.phar require --prefer-dist "macfly/yii2-markdown-doc" "^1.0.0"

or add, _(*4)

"macfly/yii2-markdown-doc": "^1.0.0"

to the require section of your composer.json file., _(*5)

Configure

Configure config/web.php as follows, _(*6)

'modules' => [
    ................
    'doc'  => [
        'class' => 'macfly\yii2\doc\Module',
        // Directory to list
        'rootDocDir' => '@app/docs',
        // set false if you don't want to cache generated html, usefull for debugging 
        //'cache' => true,
    ]
    ................
],

Usage

To access the doc, go to http://yoursite.com/doc/, _(*7)