README

这是 Markdown 解析器 Parsedown 的服务提供者。它可以很容易地与 Parsedown 或 Pimple 或 Silex 一起使用和配置。

安装

使用 Composer 安装最新版本

composer require clippings/parsedown-provider

用法

在 Pimple 容器中注册服务提供者并享受吧！

$app->register(new Clippings\ParsedownProvider\ParsedownServiceProvider());

$html = $app['parsedown']->text($markdown);

它注册了一个名为 parsedown 的服务，该服务返回同一个 Parsedown 实例。

配置

您可以这样配置它

$app->register(new Clippings\ParsedownProvider\ParsedownServiceProvider(), [
    'parsedown.markup_escaped' => true,
]);

它接受以下配置参数

• parsedown.class - 用于实例化 Parsedown 的类。默认：Parsedown。您可以使用它来加载 Parsedown 的扩展，如 ParsedownExtra。

  别忘了 composer require erusev/parsedown-extra，然后您可以这样做

  $app->register(new Clippings\ParsedownProvider\ParsedownServiceProvider(), [
      'parsedown.class' => 'ParsedownExtra',
  ]);

• parsedown.breaks_enabled - 是否将换行符视为新行。默认：true。这并不是 Markdown 和 Parsedown 的默认设置，但这是一个非常常见的配置 - 例如，GitHub 将换行符视为这样。

• parsedown.markup_escaped - 是否转义 HTML。默认：false。

• parsedown.urls_linked - 默认是否将 URL 链接起来。默认：true。这是 Parsedown 的默认设置。URL 将自动链接。它类似于 GFM。

Twig

如果您已经注册了 Twig，可能使用 TwigServiceProvider，Parsedown 服务提供者也会为您注册一个用于在模板中使用的 parsedown Twig 过滤器。

您可以使用它如下

{{ foo.markdown|parsedown }}

这将直接在您的模板中将 Markdown 转换为 HTML，并使用您配置的同一个 Parsedown 实例。

Silex 应用程序特质

如果您使用 Silex，您可以在应用程序中添加 ParsedownTrait

<?php

class Application extends Silex\Application
{
    use Clippings\ParsedownProvider\ParsedownTrait;
}

然后您可以使用它如下

$html = $app->parsedown($markdown);

作者和许可

Parsedown 提供者由 Clippings.com 团队开发，并采用 MIT 许可证发布。

在 Clippings Geeks 博客 上了解更多关于我们的项目信息。