| Name | pandoc-plantuml-filter JSON |
| Version |
0.1.5
JSON |
| download |
| home_page | |
| Summary | Pandoc filter for PlantUML code blocks |
| upload_time | 2023-12-10 12:34:40 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT |
| keywords |
plantuml
pandoc-filter
pandoc
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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.
### Control the output file-type
The generated file-type can be controlled via the file metadata:
```
---
plantuml-format: svg
---
```
Or directly via the cli `--metadata` argument.
```
pandoc tests/sample.md -o sample.pdf --filter pandoc-plantuml --metadata=plantuml-format=svg
```
## But there is ...
There are a few other filters trying to convert PlantUML code blocks however
they all failed for me.
Raw data
{
"_id": null,
"home_page": "",
"name": "pandoc-plantuml-filter",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "plantuml,pandoc-filter,pandoc",
"author": "",
"author_email": "Timo Furrer <tuxtimo@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/be/e2/e48d2c5053e566f89076a0d650d44ff8a1132701100da054c32fc557ee0d/pandoc-plantuml-filter-0.1.5.tar.gz",
"platform": null,
"description": "# pandoc-plantuml-filter\n\nPandoc filter which converts PlantUML code blocks to PlantUML images.\n\n````\n```plantuml\nAlice -> Bob: Authentication Request\nBob --> Alice: Authentication Response\n\nAlice -> Bob: Another authentication Request\nAlice <-- Bob: another authentication Response\n```\n````\n\n## Usage\n\nInstall it with pip:\n\n```\npip install pandoc-plantuml-filter\n```\n\nAnd use it like any other pandoc filter:\n\n```\npandoc tests/sample.md -o sample.pdf --filter pandoc-plantuml\n```\n\nThe PlantUML binary must be in your `$PATH` or can be set with the\n`PLANTUML_BIN` environment variable.\n\n### Additional parameters\n\nYou could pass additional parameters into `plantuml` filter which will be processed as picture's options:\n\n````\n```{ .plantuml height=50% plantuml-filename=test.png }\nAlice -> Bob: Authentication Request\nBob --> Alice: Authentication Response\n```\n````\n\nThe `plantuml-filename` parameter create a symlink for the destination picture, which could be used in the same file as an image directly.\n\n### Control the output file-type\n\nThe generated file-type can be controlled via the file metadata:\n\n```\n---\nplantuml-format: svg\n---\n```\n\nOr directly via the cli `--metadata` argument.\n\n```\npandoc tests/sample.md -o sample.pdf --filter pandoc-plantuml --metadata=plantuml-format=svg\n```\n\n## But there is ...\n\nThere are a few other filters trying to convert PlantUML code blocks however\nthey all failed for me.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Pandoc filter for PlantUML code blocks",
"version": "0.1.5",
"project_urls": null,
"split_keywords": [
"plantuml",
"pandoc-filter",
"pandoc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "30e24c488b67ef92bebc946632dd8b68b66b7cff8a9efd5b5401c919594bd049",
"md5": "423dbcc8c3c055a03cf0928f4f0ac624",
"sha256": "ad8e00752a14acf2a308914615d5ba394a0cea1c6209078076b8cb4e45c6112d"
},
"downloads": -1,
"filename": "pandoc_plantuml_filter-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "423dbcc8c3c055a03cf0928f4f0ac624",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 4358,
"upload_time": "2023-12-10T12:34:39",
"upload_time_iso_8601": "2023-12-10T12:34:39.077591Z",
"url": "https://files.pythonhosted.org/packages/30/e2/4c488b67ef92bebc946632dd8b68b66b7cff8a9efd5b5401c919594bd049/pandoc_plantuml_filter-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bee2e48d2c5053e566f89076a0d650d44ff8a1132701100da054c32fc557ee0d",
"md5": "3787d40272843559719bf936d183f702",
"sha256": "f6a5de219b82bb8e26f44a0f08f2fb32011ba04c0df753b294b7db9308646584"
},
"downloads": -1,
"filename": "pandoc-plantuml-filter-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "3787d40272843559719bf936d183f702",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 6026,
"upload_time": "2023-12-10T12:34:40",
"upload_time_iso_8601": "2023-12-10T12:34:40.733623Z",
"url": "https://files.pythonhosted.org/packages/be/e2/e48d2c5053e566f89076a0d650d44ff8a1132701100da054c32fc557ee0d/pandoc-plantuml-filter-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-10 12:34:40",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pandoc-plantuml-filter"
}
