miolae/yii2-markdown-doc Yii2 module to write documentation with MarkDown files

yii2-markdown-doc

  1. Installation
  2. Configure
  3. Usage

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 "miolae/yii2-markdown-doc" "2"

or add

"miolae/yii2-markdown-doc": "2"

to the require section of your composer.json file.

Configure

  1. 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:',
     ],
     //////////////////
    ],
    
  2. Add miolae\yii2\doc\controllers\DefaultController either to controllerMap or to urlManager. Example for url manager with pretty url enabled:
    'urlManager' => [
     'enablePrettyUrl' => true,
     'showScriptName'  => false,
     'rules'           => [
         '/doc/<page:[\w\/-\#]+>' => 'doc/default/index',
         '/doc'                   => 'doc/default/index',
     ],
    ],
    

Usage

  1. Add README.md to your docs directory (or other one you specified in rootDocDir option)
  2. To access the doc, go to http://yoursite.com/doc/
0 0
1 follower
44 downloads
Yii Version: 2.0
License: MIT
Category: User Interface
Developed by: Viktor
Created on: Jul 10, 2018
Last updated: (not set)
Packagist Profile
Github Repository

Related Extensions