macfly/yii2-markdown-doc

此包已被废弃，不再维护。未建议替代包。

Yii2模块，用于使用Markdown文件编写文档

维护者

详细信息

github.com/marty-macfly/yii2-markdown-doc

主页

源代码

问题

安装: 709

依赖者: 0

建议者: 0

安全: 0

星标: 0

关注者: 1

分支: 1

类型:yii2-module

0.0.1 2017-11-23 13:45 UTC

Requires

BSD-3-Clause f6b8defbf4e8133547efa22696e514e12d8f5396

  • Charles DELFLY <c.delfly.woop@linkbynet.com>

markdowndocyii2

This package is auto-updated.

Last update: 2020-02-06 14:24:25 UTC

README

Yii2模块，用于显示目录及其子目录中所有Markdown文件的内容。

安装

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

运行以下命令之一：

php composer.phar require --prefer-dist "macfly/yii2-markdown-doc" "^1.0.0"

或者将以下内容添加到你的 composer.json 文件的require部分。

"macfly/yii2-markdown-doc": "^1.0.0"

配置

按照以下方式配置 config/web.php

'modules' => [
    ................
    'doc'  => [
        'class' => 'macfly\yii2\doc\Module',
        // Directory to list
        'rootDocDir' => '@app/docs',
        // set false if you don't want to cache generated html, usefull for debugging 
        //'cache' => true,
    ]
    ................
],

使用方法

要访问文档，请访问 http://yoursite.com/doc/