Skip to main content

A MkDocs plugin that allows to embed PlantUML files.

Project description

mkdocs_puml_file

A MkDocs Plugin for embedding PlantUML files.

Features

This plugin enables you to embed PlantUML diagrams in your documentation. Simple add your files like you would for any other image type:

![description](my-file.puml)

Prerequisites

  1. Install mkdocs_puml_file via pip install mkdocs_puml_file.
  2. For rendering, assure plugin mkdocs_plantuml is installed via pip as well.
  3. Add plugin puml_filebefore the entry of plugin plantuml in mkdocs.yml. This is important, because MkDocs executes plugin events in the order of the plugins occurence in the configuration.

Project details


Download files

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

Source Distribution

mkdocs_puml_file-1.0.2.tar.gz (3.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdocs_puml_file-1.0.2-py3-none-any.whl (3.9 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_puml_file-1.0.2.tar.gz.

File metadata

  • Download URL: mkdocs_puml_file-1.0.2.tar.gz
  • Upload date:
  • Size: 3.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for mkdocs_puml_file-1.0.2.tar.gz
Algorithm Hash digest
SHA256 99094397fcbc712eea343e8b922f68b9a118440ec4c33e3932162fc855a2d066
MD5 0304f6a813a58f89b470db487f9bd0d8
BLAKE2b-256 8a972a0083e971b82238c136a46038519a779f0665285c5c891e3eab2b7bcb94

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_puml_file-1.0.2.tar.gz:

Publisher: python-publish.yml on TomMeHo/mkdocs_puml_file

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mkdocs_puml_file-1.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_puml_file-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c777ef489bc093103cdfab9bd02361152b21cdf50ff087fcc775f3145d583441
MD5 494cc0ee1cb416d5512e51032d0b372d
BLAKE2b-256 3b3c0a7a1b2ab94e86887aa7438066e67518f45e47e58e9740da0d607dd10c3d

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_puml_file-1.0.2-py3-none-any.whl:

Publisher: python-publish.yml on TomMeHo/mkdocs_puml_file

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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