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.5.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 294410d46fac9c58d1eba93cc729c9c0acc48cb47cc0ec729daa24ffdcb57064 |
|
MD5 | 915dcef3fed562bc7718c39c71f16506 |
|
BLAKE2b-256 | 07909dfdc2e578ce2a9e8f2fc1733df5713b1937679d0fe4b4b9a662bd11ed75 |
Close
Hashes for mkdocs_plantuml_local-0.5.0-cp311-cp311-manylinux_2_35_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8fdd916bb65ad23a82a5d91163b755b29cd04303aba90c0fd427c6a6523131ab |
|
MD5 | 89e07bd1b0eb38f6027e71f730e867a9 |
|
BLAKE2b-256 | 27ed4bde8518cde5f6d7f6d87293b9e4c6456b701d576392dd32ad855d1d92cd |