Skip to main content

pandoc-plantuml-filter

Pandoc filter which converts PlantUML code blocks to PlantUML images.

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

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

Usage

Install it with pip:

pip install pandoc-plantuml-filter

And use it like any other pandoc filter:

pandoc tests/sample.md -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/sample.md -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.

Release files for pandoc-plantuml-filter 0.1.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pandoc-plantuml-filter 0.1.5
File Size Uploaded
pandoc-plantuml-filter-0.1.5.tar.gz 6.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pandoc-plantuml-filter 0.1.5
File Interpreter ABI Platform
pandoc_plantuml_filter-0.1.5-py3-none-any.whl Python 3 none any Details

Total release size: 10.4 kB

Release files / pandoc-plantuml-filter-0.1.5.tar.gz

Download URL pandoc-plantuml-filter-0.1.5.tar.gz
Size 6.0 kB
Tags Source
SHA-256 checksum
How to use checksums
f6a5de219b82bb8e26f44a0f08f2fb32011ba04c0df753b294b7db9308646584
BLAKE2b-256 checksum
How to use checksums
bee2e48d2c5053e566f89076a0d650d44ff8a1132701100da054c32fc557ee0d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/4.0.2 CPython/3.11.7

Release files / pandoc_plantuml_filter-0.1.5-py3-none-any.whl

Download URL pandoc_plantuml_filter-0.1.5-py3-none-any.whl
Size 4.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ad8e00752a14acf2a308914615d5ba394a0cea1c6209078076b8cb4e45c6112d
BLAKE2b-256 checksum
How to use checksums
30e24c488b67ef92bebc946632dd8b68b66b7cff8a9efd5b5401c919594bd049
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/4.0.2 CPython/3.11.7

Release history Release notifications | RSS feed

This release

0.1.5 This release

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

3 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page