wnx / commonmark-markdown-renderer
将 Markdown AST 还原为 Markdown。
v1.4.1
2023-11-19 06:20 UTC
Requires
- php: ^8.1
- league/commonmark: ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.0
- phpunit/phpunit: ^10.0
- rector/rector: ^0.15.17
- vimeo/psalm: ^5.7
README
将 league/commonmark AST 还原为 Markdown。
注意:Markdown 允许使用不同的语法表示相同的元素(标题、强调、无序列表、水平线)。因此,输入和输出的 Markdown 可能不同。
安装
您可以通过 composer 安装此包
composer require wnx/commonmark-markdown-renderer
用法
use League\CommonMark\Environment\Environment; use League\CommonMark\Parser\MarkdownParser; use Wnx\CommonmarkMarkdownRenderer\MarkdownRendererExtension; use Wnx\CommonmarkMarkdownRenderer\Renderer\MarkdownRenderer; $environment = new Environment($config); $environment->addExtension(new MarkdownRendererExtension()); $markdownParser = new MarkdownParser($environment); $markdownRenderer = new MarkdownRenderer($environment); $markdown = "**Hello World!**"; $documentAST = $markdownParser->parse($markdown); // Manipulate AST in your script (append, prepend or replace nodes) $markdown = $markdownRenderer->renderDocument($documentAST);
测试
composer test
变更日志
请参阅 CHANGELOG 了解最近的变化。
贡献
请参阅 CONTRIBUTING 了解详情。
安全漏洞
请参阅 我们的安全策略 了解如何报告安全漏洞。
鸣谢
许可
MIT 许可证 (MIT)。请参阅 许可文件 了解更多信息。