README

⚠️ 重要

该项目不再维护，将不会接收任何更新，也不会支持 Laravel 的未来版本。

Laravel-Markdown-Viewer

一个轻量级、易于使用的 Laravel 包，用于处理 Markdown。它包含一个门面、一个辅助函数和一个 Blade 指令，使您的使用更加便捷。

安装

要安装它，只需使用 Composer 下载。运行 php artisan vendor:publish 命令以发布配置文件。

composer require andreasindal/laravel-markdown:"3.0.1"

Laravel 5.5 及以上版本使用包自动发现，因此您不需要手动添加 MarkdownServiceProvider。

用法

Blade 指令

您可以使用 @markdown 指令在 Blade 模板中使用 markdown 解析器。

<article>
    <h1>{{ $post->title }}</h1>

    <section class="content">
        @markdown($post->body)
    </section>
</article>

您也可以使用块状语法

@markdown
# Hello world

This *text* will be **parsed** to [HTML](https://laravel.net.cn).
@endmarkdown

门面

如果您已如上所示注册了 Markdown 门面，则可以使用它轻松解析 markdown。

$markdown = "# Hello";

$html = Markdown::parse($markdown) // <h1>Hello</h1>

辅助函数

$html = markdown('# Hello'); // <h1>Hello</h1>

$html = markdown_capture(function () {
    echo "# Hello";
    echo "\n\n";
    echo "So **cool**!"
});

// <h1>Hello</h1>
// <p>So <b>cool</b>!</p>

当然，您也可以从服务容器中解析解析器并自行使用。

$parser = app('Ingress\Markdown\Parser');
$html = $parser->parse('# Hello'); // <h1>Hello</h1>

驱动程序（新功能！）

Laravel-Markdown-Viewer 允许您添加自定义 markdown 驱动程序。要使用自定义 markdown 驱动程序，您需要创建一个实现 Ingress\Markdown\Drivers\MarkdownDriver 接口的类。该接口包含两个方法：text 和 line。其中 text 用于将一个 markdown 块转换为 HTML，而 line 用于将单行转换为 HTML。

Laravel-Markdown-Viewer 随附了一个使用 Parsedown-package 的 ParsedownDriver，由 @erusev 提供。

ingress-it-solutions / laravel-markdown-viewer

维护者

详细信息