Skip to main content

No project description provided

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_panflute-0.1.1.tar.gz (3.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file pandoc_plantuml_filter_panflute-0.1.1.tar.gz.

File metadata

File hashes

Hashes for pandoc_plantuml_filter_panflute-0.1.1.tar.gz
Algorithm Hash digest
SHA256 5bb7adccc53b8a5069ca69fee1dd1c8d394d4007f9c679f176bb61d6bddcbaa4
MD5 5c3b896597a1b90fb755d2fc39d80f49
BLAKE2b-256 7f9ed139b025fb6460db92f4fd9f702e7d19c66c94c070621233a724fef09417

See more details on using hashes here.

File details

Details for the file pandoc_plantuml_filter_panflute-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for pandoc_plantuml_filter_panflute-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8000dd1bdc0e5a2b293f3eec7e67dfdc28d09758343457ecb7efa83f3d6cf1af
MD5 f8b7acb8b360a62a879ef3ce03a33f05
BLAKE2b-256 eab1cb807ab1be96a73df5605acc5eb46a9b969caf6693fb56bfe8bb931300c1

See more details on using hashes here.

Supported by

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