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
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.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bbea82067c85c10a1bb7fdb2cd7cbd9357a5d19c128affde08f63339cc2a88ec |
|
MD5 | 8569ec7d4ad620552533f22069f7f3a9 |
|
BLAKE2b-256 | 35d5815f76e5977cb1a8dad6986db8174ad1d8410c5840657cb164ce93f7ec78 |
Close
Hashes for mkdocs_plantuml_local-0.3.0-cp311-cp311-manylinux_2_35_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4df1baaf2c9538d67800a6f0cba21c185dea7795e113b8c43f6e00aba7653b7f |
|
MD5 | 600d449cc7a1e2d702900e6b72d1b89e |
|
BLAKE2b-256 | 47767222c0109dd2c5c2e30ebb2fa61e96fb65703c32d9c45c5fe200d805a8f5 |