README

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

安装

composer require kitzberger/cakephp-markdown:dev-main

配置与使用

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

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

class FooController extends AppController
{
    public function initialize(): void
    {
        parent::initialize();
        $this->viewBuilder()->setHelpers(['Tanuck/Markdown.Markdown']);
    }
}

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

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

高级配置

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

Markdown - 使用原始语法定义：http://daringfireball.net/projects/markdown/syntax
GithubMarkdown - GitHub 自有的 Markdown 风格：https://help.github.com/articles/github-flavored-markdown/
MarkdownExtra - michelf 的原始扩展：http://michelf.ca/projects/php-markdown/extra/

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

class FooController extends AppController
{
    public function initialize(): void
    {
        parent::initialize();
        $this->viewBuilder()->setHelpers([
			'Tanuck/Markdown.Markdown' => [
				'parser' => 'GithubMarkdown',
			]
		]);
    }
}

许可

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

kitzberger / cakephp-markdown

维护者

详细信息

README

安装

配置与使用

高级配置

许可