2017 © Pedro Peláez
 

yii2-module yii2-markdown-doc

Yii2 module to write documentation with MarkDown files

image

miolae/yii2-markdown-doc

Yii2 module to write documentation with MarkDown files

  • Tuesday, May 22, 2018
  • by miolae
  • Repository
  • 1 Watchers
  • 0 Stars
  • 10 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 1 Forks
  • 2 Open issues
  • 8 Versions
  • 11 % Grown

The README.md

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

or add, (*4)

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

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

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:',
    ],
    //////////////////
],
  1. 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/

The Versions

22/05 2018

dev-master

9999999-dev https://github.com/miolae/yii2-markdown-doc

Yii2 module to write documentation with MarkDown files

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar miolae

yii2 markdown doc

22/05 2018

dev-pictures

dev-pictures https://github.com/miolae/yii2-markdown-doc

Yii2 module to write documentation with MarkDown files

  Sources   Download

MIT

The Requires

 

The Development Requires

by Avatar miolae

yii2 markdown doc

16/03 2018

dev-search

dev-search https://github.com/miolae/yii2-markdown-doc

Yii2 module to write documentation with MarkDown files

  Sources   Download

MIT

The Requires

 

by Avatar miolae

yii2 markdown doc

20/02 2018

dev-version2

dev-version2 https://github.com/miolae/yii2-markdown-doc

Yii2 module to write documentation with MarkDown files

  Sources   Download

MIT

The Requires

 

by Avatar miolae

yii2 markdown doc

20/02 2018

2.0.0

2.0.0.0 https://github.com/miolae/yii2-markdown-doc

Yii2 module to write documentation with MarkDown files

  Sources   Download

MIT

The Requires

 

by Avatar miolae

yii2 markdown doc

19/02 2018

1.0.1

1.0.1.0

Yii2 module to write documentation with MarkDown files

  Sources   Download

BSD-3-Clause

The Requires

 

by Avatar miolae

yii2 markdown doc

19/02 2018

1.0.0

1.0.0.0

Yii2 module to write documentation with MarkDown files

  Sources   Download

BSD-3-Clause

The Requires

 

by Avatar miolae

yii2 markdown doc

23/11 2017

0.0.1

0.0.1.0

Yii2 module to expose identity and rbac through a restful API

  Sources   Download

BSD-3-Clause

The Requires

 

by Charles DELFLY

yii2 markdown doc