Markdown Graphviz Inline

1.1.3 · active · verified Sat Apr 11

markdown-graphviz-inline is a Python-Markdown extension that enables rendering Graphviz DOT language diagrams directly within Markdown documents. It automatically detects ````graphviz ... ```` code blocks and replaces them with inline SVG images. This library is a Python 3 fork and continuation of the original `markdown-inline-graphviz` by Cesare Morel, currently maintained under the Backstage organization. Its current version is 1.1.3, with updates occurring on an as-needed basis.

Warnings

gotcha The underlying `graphviz` Python package (a dependency) requires the Graphviz `dot` executable to be installed on your system and available in the system's PATH. Without it, the extension will fail to render graphs, potentially with errors from the `graphviz` library.
Fix: Install Graphviz via your system's package manager (e.g., `sudo apt-get install graphviz` on Debian/Ubuntu, `brew install graphviz` on macOS, or download from graphviz.org) and ensure its executables are in your system's PATH.
gotcha The correct extension string to use with `markdown.markdown()` is `'markdown_inline_graphviz'`. Incorrect spelling or capitalization (e.g., `markdown_graphviz_inline`) will prevent the extension from loading and processing graph blocks.
Fix: Ensure `extensions=['markdown_inline_graphviz']` is used exactly as shown in your `markdown.markdown` call.
gotcha This `markdown-graphviz-inline` library is a fork of the original `markdown-inline-graphviz` (by Cesare Morel) providing Python 3 compatibility and continued maintenance. While core functionality remains similar, users migrating from the older library should be aware of potential subtle behavioral differences.
Fix: Verify behavior with existing markdown files and ensure Python 3 compatibility if migrating from the original `markdown-inline-graphviz`.

Install

pip install markdown-graphviz-inline Install package

Imports

markdown_inline_graphviz
```
import markdown
html = markdown.markdown(text, extensions=['markdown_inline_graphviz'])
```
This library is primarily used as a string extension with the `markdown` library, not via a direct Python import of a class or function.

Quickstart

Demonstrates how to parse Markdown text containing ````graphviz ... ```` blocks using the `markdown_inline_graphviz` extension and print the resulting HTML. This requires the Graphviz 'dot' executable to be installed on your system.

import markdown

# Ensure Graphviz 'dot' executable is installed on your system and in PATH.
# For example, on Ubuntu: sudo apt-get install graphviz
# On macOS: brew install graphviz

markdown_text = '''
# My Graph Report

Here's a simple directed graph:

```graphviz
digraph G {
    A -> B;
    B -> C;
    C -> A;
}
```

And a more complex one with different shapes:

```graphviz
digraph hierarchy {
    node [shape=box];
    subgraph cluster_0 {
        label = "Parent Process";
        a0 [label="Task 1"];
        a1 [label="Task 2"];
        a2 [label="Task 3"];
    }
    subgraph cluster_1 {
        label = "Child Process";
        b0 [label="Subtask 1"];
        b1 [label="Subtask 2"];
    }
    a0 -> a1 -> a2;
    a2 -> b0;
    b0 -> b1;
}
```
'''

html_output = markdown.markdown(
    markdown_text,
    extensions=['markdown_inline_graphviz']
)

print(html_output)

view raw JSON →