petrleocompel/

yii2-markdown-docs

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

Yii2 markdown 文档模块

维护者

详细信息

github.com/petrleocompel/yii2-markdown-docs

主页

源代码

问题

安装: 21

依赖: 0

建议者: 0

安全: 0

星星: 1

关注者: 1

分支: 2

开放问题: 0

类型:yii2-extension

dev-master / 1.0.x-dev 2016-10-15 15:32 UTC

Requires

BSD-3-Clause 4fa6651c0fc08d5dc0dbad8f00a11914b18f8804

  • Petr Leo Compel <petr.compel.woop@futuretek.cz>

modulemarkdownyii2

This package is not auto-updated.

Last update: 2020-01-18 10:07:52 UTC

README

安装

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

运行

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

或运行

composer require petrleocompel/yii2-markdown-docs

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

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

到

配置

在您的配置中启用此模块

'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
    ],
],

路由

向您的 URL 管理组件添加规则

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

您的文档将可通过应用程序的 /doc URL 访问。

您可以更改此 URL，但如果您的 @app 是 @webroot，则如果将其更改为 /docs，可能会发生冲突。

因此，为了兼容性，我建议使用 /doc

使用方法

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

制作文档

在 @app/docs 下，您应创建您的 md 文件。您无需创建列表，这是自动的。

文档标题

文件中的每一行都应该有 #，表示标题 1。