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`
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pandoc-plantuml-latex-0.2.1.tar.gz.
File metadata
- Download URL: pandoc-plantuml-latex-0.2.1.tar.gz
- Upload date:
- Size: 3.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
990d17f704c99aa31e1a8dfc695dc765dfe110ddc8647069acf6bbc0c0eeb451
|
|
| MD5 |
4ab09e1a4eada079ea6e99c0b974851e
|
|
| BLAKE2b-256 |
73ebe50f01ecf7f8d410e712dee9c44bc695290f4d3445d9bf57336a480dc685
|
File details
Details for the file pandoc_plantuml_latex-0.2.1-py3-none-any.whl.
File metadata
- Download URL: pandoc_plantuml_latex-0.2.1-py3-none-any.whl
- Upload date:
- Size: 4.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8756fcb5ac1277778c2d3397ad1a46ac5132d1fecfd77c543dfe7935e4e02069
|
|
| MD5 |
c2923f0421ab31de786dcf0fc69b31ac
|
|
| BLAKE2b-256 |
af78690b66a3137e28d22c66daf36e84f5c18493871818fdafcc27bae82d0df6
|