miolae/yii2-markdown-doc

使用Markdown文件编写文档的Yii2模块

维护者

详细信息

github.com/viktorprogger/yii2-markdown-doc

主页

源代码

问题

安装次数: 3,796

依赖者: 0

建议者: 0

安全性: 0

星星: 1

关注者: 2

分支: 1

类型:yii2-module

2.0.6 2019-12-04 14:03 UTC

Requires

Requires (Dev)

MIT 069461f3e6f24480494e627860bc711a3988ca96

  • Miolae <viktorprogger.woop@gmail.com>

markdowndocyii2

This package is auto-updated.

Last update: 2024-09-05 00:15:15 UTC

README

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

安装

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

运行以下命令之一：

php composer.phar require --prefer-dist "miolae/yii2-markdown-doc" "2"

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

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

。

配置

  1. 按照以下方式在 config/web.php 中配置模块：
'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. 将 miolae\yii2\doc\controllers\DefaultController 添加到 controllerMap 或 urlManager。以下是在启用美观URL的url manager的示例
'urlManager' => [
    'enablePrettyUrl' => true,
    'showScriptName'  => false,
    'rules'           => [
        '/doc/<page:[\w\/-\#]+>' => 'doc/default/index',
        '/doc'                   => 'doc/default/index',
    ],
],

使用方法

  1. 将 README.md 添加到您的 docs 目录（或您在 rootDocDir 选项中指定的其他目录）
  2. 要访问文档，请访问 http://yoursite.com/doc/