2017 © Pedro Peláez
 

yii2-extension yii2-markdown-docs

Yii2 markdown documentation module

image

jhancock/yii2-markdown-docs

Yii2 markdown documentation module

  • Thursday, August 27, 2015
  • by jhancock
  • Repository
  • 1 Watchers
  • 0 Stars
  • 6 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 2 Forks
  • 1 Open issues
  • 1 Versions
  • 0 % Grown

The README.md

yii2-markdown-docs

Installation

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

Either run, (*2)

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

or add, (*3)

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

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

Configuration

Enable the module in your confguration:, (*5)

'modules' => [
    'docs' => [
        'class' => 'jhancock\markdowndocs\Module',
        // Optional, defaults to cebe\markdown\GithubMarkdown
        'parserClass' => 'cebe\markdown\GithubMarkdown'
    ],
],

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

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

Your documentation would then be accessible under your application's /docs URL., (*7)

Usage

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

The Versions

27/08 2015

dev-master

9999999-dev https://github.com/jasonhancock/yii2-markdown-docs

Yii2 markdown documentation module

  Sources   Download

BSD-3-Clause

The Requires

 

by Jason Hancock

yii2 module markdown