Yii2 module to display the content of all markdown file in a directory and its sub-folder.
The preferred way to install this extension is through composer.
Either run
php composer.phar require --prefer-dist "miolae/yii2-markdown-doc" "2"
or add
"miolae/yii2-markdown-doc": "2"
to the require section of your composer.json
file.
- Configure the module in config/web.php as follows
'modules' => [
//////////////////
'doc' => [
'class' => 'miolae\yii2\doc\Module',
// Directory to list
'rootDocDir' => '@app/docs',
// set false if you don't want to cache generated html, useful for debugging
'cache' => true,
// Prefix for browser title, i.e: Documentation: Page Title
'titlePrefix' => 'Documentation:',
],
//////////////////
],
- Add
miolae\yii2\doc\controllers\DefaultController
either tocontrollerMap
or tourlManager
. Example for url manager with pretty url enabled:
'urlManager' => [
'enablePrettyUrl' => true,
'showScriptName' => false,
'rules' => [
'/doc/<page:[\w\/-\#]+>' => 'doc/default/index',
'/doc' => 'doc/default/index',
],
],
- Add
README.md
to yourdocs
directory (or other one you specified inrootDocDir
option) - To access the doc, go to http://yoursite.com/doc/