petrleocompel/yii2-markdown-docs

Yii2 markdown documentation module

Yii2 Markdown docs

Installation

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

Either run, _(*2)

php composer.phar require --prefer-dist petrleocompel/yii2-markdown-docs "*"

or run, _(*3)

composer require petrleocompel/yii2-markdown-docs

or add, _(*4)

"petrleocompel/yii2-markdown-docs": "*"

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

Configuration

Enable the module in your confguration:, _(*6)

'modules' => [
    'docs' => [
        'class' => 'petrleocompel\yii2\markdowndocs\Module',
        // You can set custom parserClass
        //'parserClass' => 'cebe\markdown\GithubMarkdown'
        'skipFirstHeading' => false, // if you want to skip rendering of first heading
    ],
],

Routing

Add a rule to your url manager component:, _(*7)

'urlManager' => [
    'enablePrettyUrl' => true,
    'showScriptName'  => false,
    'rules' => [
        ...
        [
            'pattern'      => 'doc<page:.+>',
            'route'        => 'doc/default/view',
            'encodeParams' => false
        ],
        ...
    ],
],

Your documentation would then be accessible under your application's /doc URL., _(*8)

You can change this url but if your @app is your @webroot then if you will change it to /docs there could be collision., _(*9)

So for compatibility i recommend to use /doc, _(*10)

Usage

This module assumes your documentation lives under the @app/docs alias., _(*11)

Make doc

Under @app/docs you should make your md files. You dont have to create listing its automatic., _(*12)

Titles of doc

On every 1 line of file should be # means Heading 1, _(*13)