Crates.io | mdbook-puml |
lib.rs | mdbook-puml |
version | 0.1.1 |
source | src |
created_at | 2020-05-16 19:05:31.874358 |
updated_at | 2020-05-16 20:10:04.588382 |
description | A simple mdbook preprocessor for rendering inline PlantUML code blocks into inline SVG |
homepage | |
repository | https://github.com/hamaluik/mdbook-puml |
max_upload_size | |
id | 242472 |
size | 71,819 |
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:
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.
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!
```