visuellverstehen/markdown-to-html

维护者

详细信息

github.com/visuellverstehen/markdown-to-html

源代码

问题

安装量: 1,447

依赖关系: 0

建议者: 0

安全性: 0

星标: 4

关注者: 6

分支: 0

公开问题: 3

v1.4 2022-02-25 08:04 UTC

Requires

Requires (Dev)

MIT d28e853e47bac0539ee7c858affd380539de10eb

  • visuellvertsehen

frameworkmarkdownlaravelLaravel MarkdownLaravel-Markdowncommonmarkcommon markvisuellverstehen

This package is auto-updated.

Last update: 2024-09-22 22:12:34 UTC

README

安装

composer require visuellverstehen/markdown-to-html

用法

可能存在这种情况，例如使用 TailwindCss 时，您可能希望使用自定义类来设置输出的样式。

入门

use VV\Markdown\Facades\Markdown;

Markdown::parse($yourContent); // The output will be HTML

配置

首先，您需要发布您的供应商资产

$ php artisan vendor:publish

然后选择markdown选项。这将创建一个可在您的应用中修改以设置配置的 config/markdown.php 文件。

要添加或更改样式集，只需添加或更改一个包含应添加到HTML标签的类的数组。

'default' => [
    'h1' => 'text-2xl',
    'a'  => 'link hover:text-blue',
    'p' => 'mb-5',
    'li p' => 'mb-2 ml-4',
],

此示例使用TailwindCSS，但您可以使用任何类型的CSS。

示例输出

<h1 class="text-2xl">A headline</h1>
<p class="mb-5">Some text</p>

<ul>
    <li><p class="mb-2 ml-4">A list item</p></li>
    <li><p class="mb-2 ml-4">A list item</p></li>
    <li><p class="mb-2 ml-4"><a class="link hover:text-blue" href="#">Klick me</a></p></li>
</ul>

<p class="mb-5">Another text</p>

多样式

在您的配置中定义多个样式，以便您可以在不同地方切换它们并使用不同的样式。

// config/markdown.php
'styles' => [
    'default' => [
        'h1' => 'text-2xl',
        'p' => 'mb-2',
    ],
    'wiki' => [
        'h1' => 'text-4xl',
        'p' => 'mb-8',
    ],
    ...

定义 style 以在样式之间切换。

Markdown::style('wiki')->parse($yourContent);

无需定义默认值。如果没有提供任何内容，markdown将查找默认样式。

关于我们

许可证

MIT许可证（MIT）。请参阅我们的 许可证文件 了解更多信息。