ramnzys / commonmark-kroki
使用league/commonmark通过kroki服务渲染图表。
1.0.0
2021-03-03 19:48 UTC
Requires
- league/commonmark: ^1.5
This package is auto-updated.
Last update: 2024-09-29 06:02:57 UTC
README
league/commonmark的块渲染器,用于使用yuzutech/kroki渲染块。league/commonmark和yuzutech/kroki。
Kroki提供支持BlockDiag (BlockDiag, SeqDiag, ActDiag, NwDiag, PacketDiag, RackDiag),BPMN,Bytefield,C4(与PlantUML一起),Ditaa,Erd,GraphViz,Mermaid,Nomnoml,PlantUML,SvgBob,UMLet,Vega,Vega-Lite和WaveDrom…等统一API,并将继续添加更多功能!
安装
您可以通过composer安装此包
composer require ramnzys/commonmark-kroki
使用方法
创建自定义CommonMark环境,并按照league/commonmark文档中描述的方式注册KrokiExtension
。
use League\CommonMark\CommonMarkConverter; use League\CommonMark\Environment; use Ramnzys\CommonmarkKrokiExtension\KrokiExtension; $environment = Environment::createCommonMarkEnvironment(); $environment->addExtension(new KrokiExtension()); $config = []; $commonMarkConverter = new CommonMarkConverter($config, $environment); $markdownContent = <<<EOT ```kroki:graphviz digraph sample { a->b,c->d } ``` ```plantuml a->b ``` EOT; $htmlContent= $commonMarkConverter->convertToHtml($markdownContent); echo $htmlContent;
渲染的HTML输出
<img src="https://kroki.io/graphviz/svg/eJxLyUwvSizIUChOzC3ISVWo5lIAgkRduySdZF27FBCvlgsA13gKJA" />
<img src="https://kroki.io/plantuml/svg/eJxL1LVL4gIABCYBOQ" />
配置
此扩展默认使用的配置是
$config = [ 'kroki' => [ 'server' => 'https://kroki.io', 'format' => 'svg', 'auto' => ['plantuml'] ] ];
变更日志
请查看CHANGELOG以了解最近有哪些更改。
许可证
MIT许可证(MIT)。请参阅许可证文件以获取更多信息。