Skip to main content

Pandoc filter for PlantUML code blocks

Project description

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.

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.4.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

pandoc_plantuml_filter-0.1.4-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

Details for the file pandoc-plantuml-filter-0.1.4.tar.gz.

File metadata

File hashes

Hashes for pandoc-plantuml-filter-0.1.4.tar.gz
Algorithm Hash digest
SHA256 d1755879b28c327c4a6f1408e283645680a4929cd78e2b08382ae8475902e8bb
MD5 26f8e386c88c4ec746103dd3e3bbd6d3
BLAKE2b-256 1508c9206e1c279e04cfa7d0c806a72dabbeffeb27afff5a0ad4eae82ec02b75

See more details on using hashes here.

Provenance

File details

Details for the file pandoc_plantuml_filter-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for pandoc_plantuml_filter-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 fc5f26dcf4c3f26dfe4f257aaa2a46829ec1055a408ccc0f068caef04c3dce81
MD5 f3bf91a1cf0b97d6ca1e687603bd83ac
BLAKE2b-256 12e155b15a5aaa42c353fea9e84d2eb89362e405be5e59d6f00e7caabd0e3067

See more details on using hashes here.

Provenance

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