README

laravel-markdown 是一个简单、轻量级的 Laravel 应用程序中清理和调整 Markdown 内容的包。它提供了从 Markdown 标题中移除加粗格式和根据可配置的最大级别动态调整 Markdown 内容中标题级别的功能。这在渲染用户生成的内容并确保应用程序中 Markdown 格式的一致性时特别有用。

功能

移除标题的加粗：自动从 Markdown 标题中移除加粗格式（例如，**标题**）。
调整标题级别：根据可配置的最大级别动态调整 Markdown 标题级别（例如，## 到 ### 等）。

安装

您可以通过 composer 安装此包

composer require mindtwo/laravel-markdown

用法

要清理您的 Markdown 内容，您可以使用 CleanupMarkdown 类，该类处理从标题中移除加粗格式和调整标题级别。

示例

use mindtwo\LaravelMarkdown\CleanupMarkdown;

$markdown = "# **Bold Heading**\n## **Bold Subheading**";
$cleanedMarkdown = (new CleanupMarkdown())->execute($markdown, 2);

echo $cleanedMarkdown;
// Outputs:
// ## Heading
// ### Subheading

在这个示例中，最大标题级别设置为 2，因此所有 # 标题都调整为 ##，并且从两个标题中都移除了加粗格式。

自定义

您可以在调用 execute 方法时指定最大标题级别。这决定了标题级别将如何调整。

$cleanedMarkdown = (new CleanupMarkdown())->execute($markdown, 3); // Max headline level is 3

测试

要运行包的测试，请使用

composer test

更新日志

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

贡献

欢迎贡献！有关如何贡献的详细信息，请参阅贡献指南。

安全漏洞

如果您发现任何与安全相关的问题，请查阅我们的安全策略了解如何报告。

鸣谢

许可

MIT 许可证 (MIT)。有关更多信息，请参阅许可文件。

mindtwo / laravel-markdown

维护者

详细信息

README

功能

安装

用法

示例

自定义

测试

更新日志

贡献

安全漏洞

鸣谢

许可