Skip to main content

Co-locate your plantuml source files and have them exported and linked to your techdocs

Project description

Plantuml Techdoc embedded tool for MkDocs

Allows you to co-locate your plantuml and have it embedded into your tech docs

How to use

First install the package

pip install mkdocs-plantuml

Enable in mkdocs

plugins:
 - plantuml-colocator

Once installed, link to plantuml in markdown

![Alt Text](my-diagram.puml)

Place the .puml source file in the same directory as the markdown (co-located)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

mkdocs_plantuml-0.1.1-py3-none-any.whl (4.6 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_plantuml-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_plantuml-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 eddd088eb448e9568b525cd5b857bbe7da059a477f6c047ef327c7f703fd2404
MD5 6104da595e31f6f5d085bfd449a426f1
BLAKE2b-256 cf117e45053dc812078ab0313c412313cf8a92419a1dfd9a48e4d870ced9097f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page