cwbit/cakephp-markdown

该软件包最新版本(1.1.0)没有可用的许可证信息。

Cake 3.x 的视图助手,可以将 Markdown 解析成 HTML

安装数: 2,264

依赖者: 1

推荐者: 0

安全性: 0

星标: 2

关注者: 2

分支: 0

开放问题: 0

类型:cakephp-plugin

1.1.0 2016-06-10 12:28 UTC

This package is not auto-updated.

Last update: 2024-09-14 19:42:06 UTC


README

CakePHP 3.x 的视图助手插件,可以将 Markdown 转换为 HTML

为什么?

因为 Markdown 非常性感,并且是一种允许用户友好编辑的绝佳方式,HTML 是在运行时(或缓存,或你想要的任何方式)生成的。

如何?

只需将 Markdown.Markdown 助手添加到你的视图中并使用它。简单易懂。

要求

目录

  1. 插件安装
  2. 使用方法
  3. 贡献

插件安装

该插件位于 Packagist,这意味着可以使用 Composer 轻松安装。

composer require cwbit/cakephp-markdown "~1.0"

然后在你的 config/bootstrap.php 文件中正常加载插件

# in ../config/bootstrap.php - right after Plugin::load('Migrations') is fine!
Plugin::load('Markdown');

不支持也不推荐手动安装 - 只需将 MarkdownHelper 放到你的 src\View\Helper 中,并更改命名空间等。

使用方法

首先,确保你已经加载了插件(参见上面)

然后,通过 AppView 或你喜欢的任何方式添加 MarkdownHelper

namespace App\View;

use Cake\View\View;

class AppView extends View
{
    public function initialize()
    {
        parent::initialize();
		# ..
        $this->loadHelper('Markdown.Markdown');
    }
}

然后,在模板文件中使用助手

<div class="description">
	<?= $this->Markdown->toHtml($entity->description); ?>
</div>

贡献

如果你想贡献,请提交包含你更改的 PR!

如果请求附带 测试,将更容易被接受 :)