markdown-inline-graphviz-extension

What it is and what it does

This is a Markdown extension that lets you embed Graphviz diagram definitions directly in your Markdown source code and have them automatically rendered as inline SVG or PNG images. It's designed for static site generators like MkDocs, Pelican, and Nikola, where you can activate it as a standard Markdown extension without needing to configure output directories or external rendering pipelines.

The extension supports all major Graphviz layout engines (dot, neato, fdp, sfdp, twopi, circo) and uses a simple code-fence syntax to define graphs. It's a continuation of an earlier project, updated to work with Python 3 and modern versions of Markdown. The package has one runtime dependency on Markdown itself and installs as a pure Python wheel.

Use it for:

• Embed flowcharts or architecture diagrams directly in MkDocs documentation without external build steps.
• Add graph visualizations to static blog posts generated with Pelican or Nikola.
• Render network topology or entity-relationship diagrams inline within Markdown files for technical documentation.
• Create decision trees or state diagrams in README files or wiki pages that use Markdown rendering.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

A Markdown extension that converts inline Graphviz diagram definitions into embedded SVG or PNG images during Markdown processing.

Yes, if you use a Markdown-based static site generator and need to embed Graphviz diagrams without extra configuration. The low install friction and permissive license make it straightforward to add. However, the aging maintenance status (385 days since last release, minimal repository activity) means you should verify that it works with your current Markdown and Python versions before relying on it for production documentation. No known security vulnerabilities.

Install

markdown-inline-graphviz-extension on PyPI

pip install markdown-inline-graphviz-extension

uv add markdown-inline-graphviz-extension

poetry add markdown-inline-graphviz-extension

Installing markdown-inline-graphviz-extension

Before you install

Low install friction; a single pure-Python wheel with one runtime dependency on Markdown. Maintenance is aging—last release was 385 days ago with minimal repository activity (5 stars), though marked Production/Stable.

License in practice

MIT license (permissive); you can use, modify, and distribute this package freely in commercial or private projects with minimal restrictions.

Quickstart

pip install markdown_inline_graphviz_extension

In mkdocs.yml:
markdown_extensions:
    - markdown_inline_graphviz

In Markdown:
```graphviz dot output.svg
digraph G {
    Earth -> Mars
}
```

Graphviz command-line tools (dot, neato, fdp, sfdp, twopi, circo) must be installed separately on the system.

Verify before relying

• Exact Graphviz system dependencies and installation requirements for different operating systems.
• Compatibility with all current Markdown versions and known issues if any.
• Performance impact when rendering many or complex graphs in a single document.

Package facts

Evidence: markdown_inline_graphviz_extension-1.1.3-py3-none-any.whl

Tags

More Markup packages