plantuml-markdown
A PlantUML plugin for Markdown
Decision gist · record as of 2026-08-14
Yes, if you use Markdown for documentation and want to embed UML diagrams without manual image creation. Install is frictionless and the package is actively maintained. Requires either a local PlantUML setup (Java + Graphviz) or network access to a remote server—factor that into your workflow before committing. No security issues reported.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires PlantUML binary installed locally (with Java and Graphviz) or a configured remote PlantUML/Kroki server URL; Markdown processing requires Python-Markdown.
- Low friction: pure Python wheel with no runtime dependencies.
- Active maintenance—last commit 2026-04-18, 226 repository stars.
License · maintenance · safety
permissive license (permissive) — Permissive license (BSD). No restrictions on commercial or private use; safe to include in proprietary projects.
last release 2026-04-18 (118 days) · last repo commit 2026-04-18 · 226 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 940,487 downloads/mo, #4,682 on PyPI
Alternatives
Verify before relying
pip install plantuml-markdown
markdown_py -x plantuml_markdown mydoc.md > out.html
In mydoc.md:
::uml:: format="png"
Alice -> Bob: Hello
Bob --> Alice: Hi
::end-uml::- Whether the package works with current Python-Markdown versions and any version constraints beyond 'requires_python >= 3.0'.
- Performance characteristics when rendering large diagrams or many diagrams in a single document.
- Whether caching (mentioned in config) actually improves rendering speed in typical workflows.
What it is and what it does
This package extends Python-Markdown to recognize PlantUML diagram blocks and render them as images. You write diagram syntax in a Markdown code block using a special `::uml::` or ` ```plantuml ` delimiter, and the plugin converts it to an embedded PNG, SVG, or text representation in the final HTML. It supports both local PlantUML binaries (requiring Java and Graphviz) and remote rendering via PlantUML or Kroki servers, with options for image dimensions, CSS classes, alt text, and external file inclusion.
The plugin is a pure-Python wheel with no runtime dependencies, making it lightweight to install. Configuration is optional but recommended—you specify which rendering backend to use (local or remote), caching preferences, default image format, and other metadata. It integrates directly into the markdown_py command-line tool or Python-Markdown API.
Use it for
- Generate architecture and sequence diagrams automatically from Markdown documentation without manual image creation.
- Embed UML diagrams in technical specifications or design documents that are version-controlled as plain text.
- Render diagrams in static site generators (Jekyll, Hugo, Sphinx) that use Markdown as input.
- Create interactive SVG diagrams with navigable links in HTML output when using svg_object or svg_inline formats.
- Include external PlantUML files in Markdown via the source parameter for modular diagram management.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you use Markdown for documentation and want to embed UML diagrams without manual image creation.
Install is frictionless and the package is actively maintained. Requires either a local PlantUML setup (Java + Graphviz) or network access to a remote server—factor that into your workflow before committing. No security issues reported.
Install
plantuml-markdown on PyPI
Before you install
Low friction: pure Python wheel with no runtime dependencies. Active maintenance—last commit 2026-04-18, 226 repository stars. Requires external PlantUML binary or remote server access to function; not a standalone tool.
Requires PlantUML binary installed locally (with Java and Graphviz) or a configured remote PlantUML/Kroki server URL; Markdown processing requires Python-Markdown.
License in practice
Permissive license (BSD). No restrictions on commercial or private use; safe to include in proprietary projects.
Quickstart
pip install plantuml-markdown
markdown_py -x plantuml_markdown mydoc.md > out.html
In mydoc.md:
::uml:: format="png"
Alice -> Bob: Hello
Bob --> Alice: Hi
::end-uml::Verify before relying
- Whether the package works with current Python-Markdown versions and any version constraints beyond 'requires_python >= 3.0'.
- Performance characteristics when rendering large diagrams or many diagrams in a single document.
- Whether caching (mentioned in config) actually improves rendering speed in typical workflows.
Package facts
| License | permissive license permissive |
| Python support | Supports the current Python release >=3.0 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | None |
| Maintenance | Actively maintained 118 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 940,487 / month, #4,682 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableLicense :: OSI Approved :: BSD LicenseOperating System :: OS IndependentProgramming Language :: PythonTopic :: Software Development :: DocumentationTopic :: Software Development :: Libraries :: Python ModulesTopic :: Text Processing :: FiltersTopic :: Text Processing :: Markup :: HTML |
Evidence: plantuml_markdown-3.11.2-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “markdown plantuml diagram rendering”
- plantuml-markdownA Markdown extension that converts PlantUML diagram syntax into…
- sphinxcontrib-plantumlAdds PlantUML diagram rendering to Sphinx documentation, letting you…
- markdown-to-confluenceConverts Markdown files to Confluence Storage Format and publishes…
Give your agent the search over MCP, or paste the wish link into any chat.
More Python Modules packages
Converts domain names between Unicode and ASCII-compatible encoding (Punycode) according to IDNA 2008 and Unicode Technical Standard 46, with security validation and broader script coverage than the standard library.
Install it if you work with internationalized domain names, need to validate domains, or use HTTP clients that depend on it transitively.
Setuptools is a Python build backend and package management tool that handles building, distributing, and installing Python packages, including support for C/C++ extension modules.
PyYAML parses and emits YAML 1.1 data format, enabling serialization and deserialization of configuration files and Python objects to and from human-readable YAML text.
Pydantic validates Python data structures against type hints, coercing and checking input at runtime to ensure it matches a declared schema.
Provides reusable metadata objects for use with PEP-593 `typing.Annotated` to express common constraints like bounds, collection sizes, and predicates on types.
Install it if you use or build libraries that need to express type constraints in a standardized, inspectable way—or if you want to annotate your own types with…
Provides runtime tools to inspect and introspect Python type annotations, enabling programmatic examination of type hints at execution time.
See also plantuml · sphinxcontrib-plantuml · markdown-inline-graphviz-extension · markdown-graphviz-inline · markdown-pdf · essentials-openapi · mkdocs-plugin-inline-svg · mkdocs-material-extensions · markdown-to-confluence · mkdocs-kroki-plugin