---
name: "pandoc-plantuml"
section: "1"
platform: "linux"
package: "pandoc-plantuml-filter"
version: "0.1.5-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/pandoc-plantuml"
---

# pandoc-plantuml(1)

Pandoc filter: converts PlantUML code blocks to PlantUML images

## NAME

pandoc-plantuml - Pandoc filter: converts PlantUML code blocks to PlantUML images

## SYNOPSIS

**pandoc** **--filter pandoc-plantuml** \[**...**\]

## DESCRIPTION

**pandoc-plantuml** is a filter for pandoc and is not intended to be used as a standalone command.

This manual page documents briefly the **pandoc-plantuml** command.

## EXAMPLES

In your (in this example Markdown) document insert plantuml diagrams like this:

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

This will create an output file with a **plantuml**-generated image linked in the file. The image will be put under the relative dir plantuml-images.

## SEE ALSO

[**pandoc**(1)](/pandoc/1.md)

See /usr/share/doc/pandoc-plantuml-filter for more information.

## AUTHORS

**Hanno Stock** \<opensource@hanno-stock.de\>

Wrote this manpage for the Debian system.

**Timo Furrer**

provided the example.

## COPYRIGHT

Copyright © 2019 Hanno Stock\

This manual page was written for the Debian system (and may be used by others).

Permission is granted to copy, distribute and/or modify this document under the terms of the MIT License.

See /usr/share/doc/pandoc-plantuml-filter/copyright for full licensing information.
