macfly/yii2-markdown-doc

This package is abandoned and no longer maintained. No replacement package was suggested.

Yii2 module to write documentation with MarkDown files

0.0.1 2017-11-23 13:45 UTC

Requires

• kartik-v/yii2-markdown: *
• yiisoft/yii2: ~2.0.5

BSD-3-Clause

• Charles DELFLY

• markdown
• doc
• yii2

README

Yii2 module to display the content of all markdown file in a directory and its sub-folder.

Installation

The preferred way to install this extension is through composer.

Either run

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

or add

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

to the require section of your composer.json file.

Configure

Configure config/web.php as follows

'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/