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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c092fde7f249e15ed834eb4626afb6f9cdda82500ab944e154cf2e80ed918da5 |
|
MD5 | b811f2a3e6323a1cbd38e908c6f68ad0 |
|
BLAKE2b-256 | 8bd35a3d05f7bbe9d345119eb4d82810ec28e158bbd0d095f4a6f6138d49b17c |
Close
Hashes for mkdocs_plantuml_local-0.4.1-cp311-cp311-manylinux_2_35_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 27d424e21c44ddf2b9191062abdad37e05435d63d5430813277196fc1908f86f |
|
MD5 | c7ecd4f04b8cbfd89e0b58fb5ec98dd5 |
|
BLAKE2b-256 | 104c2f246fdf203dfbf296bb143f19f4f71f2564b249ffe2f3e1185b116f2b79 |