Render PlantUML diagrams without sending sensitive data to a public server
Project description
MkDocs PlantUML Local
Render Plantuml codeblocks in mkdocs without sending sensitive diagrams to a public server.
Configuration
Minimal
plugins:
- plantuml-local
markdown_extensions:
- pymdownx.superfences:
custom_fences:
- name: plantuml
class: plantuml
format: !!python/name:pymdownx.superfences.fence_code_format
All
plugins:
- plantuml-local:
# shortname is language used to identify
# blocks to process, defaults to `plantuml`
shortname: puml
# background_colour sets the background
# fill colour used, defaults to `transparent`
background_colour: white
# class_name is the css class to assign to the
# rendered svg diagram, by default no class
# name is set.
class_name: plantuml-diagram
# cache, when set to true, will cache rendered
# diagrams under the folder `.cache`. Not
# recommended for use in CI, so add `.cache`
# to your .gitignore
cache: true
markdown_extensions:
- pymdownx.superfences:
custom_fences:
- name: puml
class: puml
format: !!python/name:pymdownx.superfences.fence_code_format
Licence
This MkDocs plugin is licenced under the MIT license.
Plantuml is redistributed with this package, under the GPL-3.0 license.
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
Close
Hashes for mkdocs_plantuml_local-0.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 375d8ec18bdb4687882b07f0a7d7a45e5749a1d3f229486f55be469db3da820e |
|
MD5 | 107b71c981601fdc33ede28e17472abb |
|
BLAKE2b-256 | 957dce8fbb185d3353dc5364d22253eda2aeee2b953aed7db8899392d74a97b8 |
Close
Hashes for mkdocs_plantuml_local-0.4.0-cp311-cp311-manylinux_2_35_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | caec642d50dccde778c2cbc7f1b99dd00a175e44cb006aa46a3e6dc81bb29e34 |
|
MD5 | 06ecc165ed576309bfa57ed1980aa017 |
|
BLAKE2b-256 | e27a89c42d031fbaeff76f212b12f33f30f01c623d63d45678ad779b84126a6a |