README

安装

Composer

您可以使用 composer 将此插件安装到您的 CakePHP 应用程序中。

安装 composer 包的推荐方法是

composer require ivanamat/cakephp3-markdown

Git 子模块

git submodule add git@github.com:ivanamat/cakephp3-markdown.git plugins/Markdown
git submodule init
git submodule update

加载

组件

在 initialize() 函数中加载组件

    class MyController extends AppController {

        public function initialize() {
            parent::initialize();

            $this->loadComponent('Markdown.Markdown');
        }

    }

...或者从 components 数组 中加载组件。

    class MyController extends AppController {

        public $components = [
            'Markdown' => [
                'className' => 'Markdown.Markdown'
            ]
        ];

    }

助手

从您的 View 在 initialize() 函数中加载助手

    class AppView extends View {

        public function initialize() {
            parent::initialize();

            $this->loadHelper('Markdown.Markdown');
        }

    }

易于使用

控制器

示例：在控制器中读取 .md 文件，解析并将 HTML 代码传递给视图。

    # MyController

    $md = file_get_contents('../README.md', true);
    $html = $this->Markdown->parse($md);
    $this->set(compact('html'));

助手

示例：在视图中解析 Markdown 数据。

    # MyController

    $md = '`This` string `is an example` of **Markdown** code';
    $this->set(compact('md'));

    <!-- My view.ctp -->

    <?php echo $this->Markdown->parse($md); ?>

关于 CakePHP 3.x - Markdown

CakePHP 3.x - Markdown 使用了第三方库 Parsedown。
您可以从官方网站下载 Parsedown： http://parsedown.org/。

作者

Iván Amat 在 GitHub
www.ivanamat.es