/mdbook-puml

A simple mdbook preprocessor for rendering inline PlantUML code blocks into inline SVG

Primary LanguageRustApache License 2.0Apache-2.0

mdbook-puml

Crates.io

This is a simple mdbook preprocessor designed to replace code blocks that look like:

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

with an inline SVG rendered using PlantUML:

BobBobAliceAlicehello

I created this preprocessor because mdbook-plantuml wasn't working for me—specifically, mdbook-plantuml is currently incompatible with mdbook watch and mbbook serve because it triggers a rebuild loop.

This crate is quite simple and non-customizable at this point as it does all that I need it to for my own purposes. Feel free to fork and/or PR away though, and I'll be happy to include changes.

Usage

To install mdbook-puml, use cargo:

cargo install mdbook-puml

Then add the following to book.toml:

[preprocessor.puml]

Finally, to insert a PlantUML diagram somewhere, just use a fenced code block with the language set to plantuml:

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