Skip to main content

Markdown Inline Graphviz (for Python 3)

This is just a continuation of the great job of Steffen Prince in sprin/markdown-inline-graphviz, in order to get it work with pip3. If you use python 2, please use the original extension instead.

A Python Markdown extension that replaces inline Graphviz definitions with inline SVGs or PNGs!

Why render the graphs inline? No configuration! Works with any Python-Markdown-based static site generator, suche originas MkDocs, Pelican, and Nikola out of the box without configuring an output directory.

Installation

$ pip3 install markdown_inline_graphviz_extension --user

Usage

Activate the markdown_inline_graphviz extension. For example, with Mkdocs, you add a stanza to mkdocs.yml:

markdown_extensions:
    - markdown_inline_graphviz

To use it in your Markdown doc, with SVG output:

```graphviz dot attack_plan.svg
digraph G {
    rankdir=LR
    Earth [peripheries=2]
    Mars
    Earth -> Mars
}
```

or with PNG:

```graphviz dot attack_plan.png
digraph G {
    rankdir=LR
    Earth [peripheries=2]
    Mars
    Earth -> Mars
}
```

Alternatively you can still using {% legacy notation but its not recommended.

{% dot attack_plan.svg
    digraph G {
        rankdir=LR
        Earth [peripheries=2]
        Mars
        Earth -> Mars
    }
%}

Supported graphviz commands: dot, neato, fdp, sfdp, twopi, circo.

Credits

Inspired by jawher/markdown-dot, which renders the dot graph to a file instead of inline.

Forked from sprin/markdown-inline-graphviz

License

MIT License

Release files for markdown-inline-graphviz-extension 1.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for markdown-inline-graphviz-extension 1.1.3
File Size Uploaded
markdown_inline_graphviz_extension-1.1.3.tar.gz 4.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for markdown-inline-graphviz-extension 1.1.3
File Interpreter ABI Platform
markdown_inline_graphviz_extension-1.1.3-py3-none-any.whl Python 3 none any Details

Total release size: 9.3 kB

Release files / markdown_inline_graphviz_extension-1.1.3.tar.gz

Download URL markdown_inline_graphviz_extension-1.1.3.tar.gz
Size 4.4 kB
Tags Source
SHA-256 checksum
How to use checksums
215b74334cfa1316bb6afa6f0a1f9b3dd5a9c18de2c29d39793e09ab067aeec7
BLAKE2b-256 checksum
How to use checksums
cc15fd9c1fc72ddc82833b2e5f9de0123fa8f60b72500c2d39ddb065881fad5b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.3

Release files / markdown_inline_graphviz_extension-1.1.3-py3-none-any.whl

Download URL markdown_inline_graphviz_extension-1.1.3-py3-none-any.whl
Size 4.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
661b7bb42e23bf808cd4c137e2d0c7f2ee788fe87104e282a4d3a818a56a55b5
BLAKE2b-256 checksum
How to use checksums
5e2889528059ae272924030d86368c9cc78b1fb6ef3d50ca7b9d225abe22f3cd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.3

Release history Release notifications | RSS feed

This release

1.1.3 This release

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.1

2 release files

1.0.3

2 release files

1.0.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page