semvec/pypi-packages huggingface dataset:
markdown-inline-graphviz 1.0
Render inline graphs with Markdown and Graphviz
License: MIT

========================
Markdown Inline 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.

.. _MkDocs: http://www.mkdocs.org/
.. _Pelican: http://blog.getpelican.com/
.. _Nikola: https://getnikola.com/

Installation
============

.. code::

    $ pip install markdown-inline-graphviz

Usage
=====

Activate the `inline_graphviz` extension. For example, with Mkdocs, you add a
stanza to mkdocs.yml:

.. code::

   markdown_extensions:
       - inline_graphviz

To use it in your Markdown doc:

.. code::

   {% 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.

.. _jawher/markdown-dot: https://github.com/jawher/markdown-dot

License
=======

MIT License