README

此包包含

• 一个可以渲染Markdown的Blade组件
• 一个高度可配置的类，您可以使用它来渲染Markdown

以下是一个提供的 x-markdown Blade组件的示例。以下Markdown...

<x-markdown>
# My title

This is a [link to our website](https://spatie.be)

```php
echo 'Hello world';
```
</x-markdown>

... 将被组件转换为以下HTML块

<div>
    <h1 id="my-title">My title</h1>
    <p>This is a <a href="https://spatie.be">link to our website</a></p>
    <pre class="shiki" style="background-color: #fff"><code><span class="line"><span
        style="color: #005CC5">echo</span><span style="color: #24292E"> </span><span style="color: #032F62">&#39;Hello world&#39;</span><span
        style="color: #24292E">;</span></span>
<span class="line"></span></code></pre>
</div>

您还可以以编程方式渲染HTML。

// by resolving the class out of the container all the options
// in the config file will be used.

app(Spatie\LaravelMarkdown\MarkdownRenderer::class)->toHtml($markdown);

默认情况下，x-markdown组件和MarkdownRenderer可以

• 正确突出显示代码块（通过Shiki PHP），支持100多种语言，包括PHP、JS、Blade、以及其他更多。
• 为标题添加锚点链接
• 缓存结果以提高性能

支持我们

我们投入了大量资源来创建一流的开源软件包。您可以通过购买我们的付费产品之一来支持我们。

我们非常感谢您从您的家乡给我们寄来明信片，并说明您正在使用我们哪个包。您可以在我们的联系页面找到我们的地址。我们将发布收到的所有明信片在我们的虚拟明信片墙上。

文档

您可以在专门的文档网站找到安装说明和详细使用说明。

相关包

如果您只需要league/commonmark扩展来突出显示代码，请访问spatie/commonmark-shiki-highlighter。

如果您不需要Markdown支持，但想直接突出显示代码，请查看spatie/shiki-php。

测试

composer test

更新日志

请参阅更新日志以获取有关最近更改的更多信息。

贡献

请参阅贡献指南以获取详细信息。

安全漏洞

请参阅我们的安全策略以了解如何报告安全漏洞。

致谢

• Freek Van der Herten
• 所有贡献者

替代方案

如果您不想自己安装和配置Shiki，请查看Torchlight，它可以以最小的设置突出显示您的代码。

许可证

MIT许可证（MIT）。请参阅许可证文件以获取更多信息。