Skip to main content

Pandoc filter for PlantUML code blocks

Project description


Pandoc filter which converts PlantUML code blocks to PlantUML images.

Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response

Alice -> Bob: Another authentication Request
Alice <-- Bob: another authentication Response


Install it with pip:

pip install pandoc-plantuml-filter

And use it like any other pandoc filter:

pandoc tests/ -o sample.pdf --filter pandoc-plantuml

The PlantUML binary must be in your $PATH or can be set with the PLANTUML_BIN environment variable.

Additional parameters

You could pass additional parameters into plantuml filter which will be processed as picture's options:

```{ .plantuml height=50% plantuml-filename=test.png }
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response

The plantuml-filename parameter create a symlink for the destination picture, which could be used in the same file as an image directly.

Control the output file-type

The generated file-type can be controlled via the file metadata:

plantuml-format: svg

Or directly via the cli --metadata argument.

pandoc tests/ -o sample.pdf --filter pandoc-plantuml --metadata=plantuml-format=svg

But there is ...

There are a few other filters trying to convert PlantUML code blocks however they all failed for me.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pandoc-plantuml-filter-0.1.5.tar.gz (6.0 kB view hashes)

Uploaded Source

Built Distribution

pandoc_plantuml_filter-0.1.5-py3-none-any.whl (4.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page