tanuck/cakephp-markdown

CakePHP 3 的 Markdown 插件。

维护者

详细信息

github.com/tanuck/cakephp-markdown

源代码

问题

安装次数: 18,385

依赖者: 0

建议者: 0

安全: 0

星标: 7

关注者: 6

分支: 5

开放问题: 5

类型:cakephp-plugin

v0.1.0 2015-02-20 22:16 UTC

Requires

Requires (Dev)

MIT 039b4ef4ca9672df4672c8fa7f3f90d2ec3daf77

  • Tanuck <tanuck.woop@gmail.com>

This package is not auto-updated.

Last update: 2024-09-14 16:44:59 UTC

README

Build Status License Total Downloads

CakePHP 3 插件，用于在视图模板中解析 Markdown 语法。

安装

在您的 composer.json 文件中包含以下内容

    "require": {
        "tanuck/cakephp-markdown": "dev-master"
    }

然后运行

composer update

配置与使用

将以下代码添加到您的 config/bootstrap.php 文件中：Plugin::load('Tanuck/Markdown');

然后，在需要的地方加载助手。例如，在您的控制器中

    class FooController extends AppController
    {
        public $helpers = ['Tanuck/Markdown.Markdown'];
    }

然后在您的模板中，您可以这样输出 Markdown 语法

    echo $this->Markdown->transform($myMarkdownSyntax);

高级配置

Markdown 使用 cebe/markdown 库进行渲染，该库提供了 3 个不同的 Markdown 解析器类。

默认情况下，插件将使用 Markdown，即上面 3 个中的第一个。但是，您可以在加载助手时指定使用哪个。如下所示

    class FooController extends AppController
    {
        public $helpers = [
            'Tanuck/Markdown.Markdown' => [
                'parser' => 'GithubMarkdown'
            ]
        ];
    }

许可证

cakephp-markdown 在 MIT 许可证 下提供。