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-latex
```

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.

## Differences from [pandoc-plantuml-filter](https://github.com/timofurrer/pandoc-plantuml-filter)

- merged pull request [Raw latex support](https://github.com/timofurrer/pandoc-plantuml-filter/pull/4)
see [tests/](tests/)

- also generate vector images for latex `beamer` template

- added debugging environment variable `DEBUG=1`


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-latex-0.2.1.tar.gz (3.1 kB view hashes)

Uploaded Source

Built Distribution

pandoc_plantuml_latex-0.2.1-py3-none-any.whl (4.0 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