skip to navigation
skip to content

markdown-inline-graphviz 1.0

Render inline graphs with Markdown and Graphviz

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

 
File Type Py Version Uploaded on Size
markdown-inline-graphviz-1.0.tar.gz (md5) Source 2015-11-27 2KB
markdown_inline_graphviz-1.0-py2-none-any.whl (md5) Python Wheel py2 2015-11-27 3KB