#plant-uml #mdbook #common-mark #markdown

app mdbook-puml

一个简单的mdbook预处理程序,用于将内联PlantUML代码块渲染为内联SVG

2个版本

0.1.1 2020年5月16日
0.1.0 2020年5月16日

#10 in #commonmark

Apache-2.0

22KB
132

mdbook-puml

这是一个简单的 mdbook 预处理器,旨在替换类似

```plantuml
Bob -> Alice : Hello!
```

的代码块,并使用 PlantUML 渲染内联SVG

BobBobAliceAlicehello

我创建这个预处理器是因为 mdbook-plantuml 对我不起作用——特别是,mdbook-plantuml 目前与 mdbook watchmbbook serve 不兼容,因为它触发了 重建循环

这个crate目前非常简单且不可定制,因为它已经满足了我自己的需求。不过,欢迎fork和/或PR修改,我会很高兴将其包含在内。

用法

要安装 mdbook-puml,请使用cargo

cargo install mdbook-puml

然后在 book.toml 中添加以下内容

[preprocessor.puml]

最后,要插入PlantUML图表,只需使用语言设置为 plantuml 的代码块即可

```plantuml
Bob -> Alice : Hello!
```

依赖关系

~14–27MB
~394K SLoC