jhancock/yii2-markdown-docs

Yii2 markdown 文档模块

维护者

详情

github.com/jasonhancock/yii2-markdown-docs

主页

源代码

问题

安装: 11

依赖者: 0

建议者: 0

安全性: 0

星标: 0

关注者: 3

分支: 2

公开问题: 0

类型:yii2-extension

dev-master 2015-08-27 20:32 UTC

Requires

BSD-3-Clause cccd29384629588e43ed9ca6a39c3836d73f7d4e

  • Jason Hancock <jason.woop@jasonhancock.com>

modulemarkdownyii2

This package is not auto-updated.

Last update: 2024-09-28 18:26:31 UTC

README

安装

安装此扩展的首选方式是通过 composer。

运行以下命令之一

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

或者在您的 composer.json 文件的 require 部分添加

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

。

配置

在您的配置中启用该模块

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

为您的 URL 管理器组件添加一个规则

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

然后，您的文档将可以通过应用程序的 /docs URL 访问。

使用方法

此模块假定您的文档位于 @app/docs 别名下。