Skip to main content

Render inline graphs with Markdown and Graphviz

Project description

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, such as MkDocs, Pelican, and Nikola out of the box without configuring an output directory.

Installation

$ pip install markdown-inline-graphviz

Usage

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

markdown_extensions:
    - inline_graphviz

To use it in your Markdown doc:

{% 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.

License

MIT License

Project details


Release history Release notifications

This version

1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for markdown-inline-graphviz, version 1.0
Filename, size File type Python version Upload date Hashes
Filename, size markdown_inline_graphviz-1.0-py2-none-any.whl (3.8 kB) File type Wheel Python version py2 Upload date Hashes View
Filename, size markdown-inline-graphviz-1.0.tar.gz (2.6 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page