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.

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-panflute 0.1.1

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-panflute 0.1.1
File Size Uploaded
pandoc_plantuml_filter_panflute-0.1.1.tar.gz 3.6 kB Details

Built distribution (wheel)

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

Total release size: 7.9 kB

Release files / pandoc_plantuml_filter_panflute-0.1.1.tar.gz

Download URL pandoc_plantuml_filter_panflute-0.1.1.tar.gz
Size 3.6 kB
Tags Source
SHA-256 checksum
How to use checksums
5bb7adccc53b8a5069ca69fee1dd1c8d394d4007f9c679f176bb61d6bddcbaa4
BLAKE2b-256 checksum
How to use checksums
7f9ed139b025fb6460db92f4fd9f702e7d19c66c94c070621233a724fef09417
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.2.2 CPython/3.10.8 Linux/6.0.9-zen1-1-zen

Release files / pandoc_plantuml_filter_panflute-0.1.1-py3-none-any.whl

Download URL pandoc_plantuml_filter_panflute-0.1.1-py3-none-any.whl
Size 4.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8000dd1bdc0e5a2b293f3eec7e67dfdc28d09758343457ecb7efa83f3d6cf1af
BLAKE2b-256 checksum
How to use checksums
eab1cb807ab1be96a73df5605acc5eb46a9b969caf6693fb56bfe8bb931300c1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.2.2 CPython/3.10.8 Linux/6.0.9-zen1-1-zen

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 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