README

A small, lightweight and easy-to-use Laravel package for handling markdown. It comes with a facade, a helper function and a Blade directive to make life easier for you.

安装

要安装它，只需使用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('Indal\Markdown\Parser');
$html = $parser->parse('# Hello'); // <h1>Hello</h1>

驱动程序（全新！）

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

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

致谢

• Mohamed Said (@themsaid)

许可

在MIT许可下发布。更多信息请参阅LICENSE文件。