parsedown/laravel

此包已弃用且不再维护。未建议替代包。

官方Parsedown的Laravel包装器。

1.2.1 2020-01-07 02:12 UTC

This package is auto-updated.

Last update: 2024-01-30 09:46:18 UTC


README

你可能也喜欢 Caret - 适用于Mac / Windows / Linux的Markdown编辑器。

Parsedown for Laravel

Build Status

此包是围绕 ParsedownLaravel 包装器。如果你想了解更多关于 Parsedown 的信息,请查看我们的 基础仓库

功能

  • Blade指令
  • 配置文件
  • 辅助函数

安装

Parsedown for Laravel 可作为 Composer 使用。您可以使用以下命令安装它

composer require parsedown/laravel

配置

如果您使用的是 Laravel +5.5,则不需要遵循以下步骤。已实现 包自动发现 功能,并将为您处理加载服务提供者。

但如果不是这种情况,您需要将服务提供者添加到您的 config/app.php 文件中

return [
    // Other configurations above...

    'providers' => [
        // Other providers above...
        Parsedown\Providers\ParsedownServiceProvider::class,
        // Other providers below...
    ],

    // Other configurations below...
];

此包使用 Parsedown\Providers\ParsedownServiceProvider 服务提供者来创建 Parsedown 的单例。它将其存储在一个名为 parsedown 的容器中。它使用以下选项来设置该实例的默认行为

名称 描述 默认
breaks_enabled 将如 \n 这样的换行符转换为 <br /> 标签。 false
inline 默认启用 parsedown() 辅助函数和 @parsedown 指令的行内解析。 false
markup_escaped 在受信任的输入中转义 HTML。如果启用 safe_mode,则冗余。 false
safe_mode 不处理未经验证的用户输入。 true
urls_linked 自动将 URL 转换为锚点标签。 true

您可以通过以下命令使用 config/parsedown.php 文件来覆盖这些值

php artisan vendor:publish --provider="Parsedown\Providers\ParsedownServiceProvider"

使用方法

以下代码片段显示了如何在您的 *.blade.php 文件中轻松使用 Parsedown

@parsedown('Hello _Parsedown_!')

...或(使用辅助函数方法)

{{ parsedown('Hello _Parsedown_!') }}

以上任何代码都将生成

<p>Hello <em>Parsedown</em>!</p>

如果您想使用行内样式解析值,只需将第二个参数设置为 true

@parsedown('Hello _Parsedown_!', true)

...或(使用辅助函数方法)

{{ parsedown('Hello _Parsedown_!', true) }}

以上任何代码都将生成

Hello <em>Parsedown</em>!

辅助函数是全局可用的,也可以在您的项目中的任何 PHP 代码中使用。

Lumen 支持

LaravelLumen 几乎共享相同的核心代码。以下说明应该足以为此包设置您的 Lumen 项目。

在您的项目中启用外观

请确保您的 bootstrap/app.php 文件中有以下内容

$app->withFacades();

服务提供者注册

由于 Lumen 不支持自动发现包,您需要手动操作,将以下代码添加到您的 bootstrap/app.php 文件中

$app->register(Parsedown\Providers\ParsedownServiceProvider::class);