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.3.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.3-py3-none-any.whl (4.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_puml_file-1.0.3.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.3.tar.gz
Algorithm Hash digest
SHA256 9eabdeac2e7a3b94410895a99df4402ed3ba6f6ca4b587d15bca4cd22cd6a28c
MD5 265223ad5a83876695f8a2c7b0105b1c
BLAKE2b-256 b28ca80610c624888124cb37c329ae51c859d20e37d2a1895faa0833b36a87f7

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_puml_file-1.0.3.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.3-py3-none-any.whl.

File metadata

File hashes

Hashes for mkdocs_puml_file-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 af5a4552783100b90ad82e3594cd9b6d48e461dd81b63deced5084e1835f1441
MD5 d393e40377d334bafdd581018125a682
BLAKE2b-256 079f2a210efd8e1715b5f923da4017fc87cdff2168e3415eeba2b8c9bd841d14

See more details on using hashes here.

Provenance

The following attestation bundles were made for mkdocs_puml_file-1.0.3-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