Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sprin/markdown-inline-graphviz
Render inline graphs with Markdown and Graphviz
https://github.com/sprin/markdown-inline-graphviz
Last synced: 7 days ago
JSON representation
Render inline graphs with Markdown and Graphviz
- Host: GitHub
- URL: https://github.com/sprin/markdown-inline-graphviz
- Owner: sprin
- License: mit
- Created: 2015-11-27T20:19:07.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2021-08-13T16:17:13.000Z (about 3 years ago)
- Last Synced: 2024-10-28T16:56:37.796Z (14 days ago)
- Language: Python
- Size: 5.86 KB
- Stars: 34
- Watchers: 7
- Forks: 22
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Markdown Inline Graphviz
========================A Python Markdown extension that replaces inline Graphviz definitins with
inline SVGs or PNGs!Why render the graphs inline? No configuration! Works with any
Python-Markdown-based static site generator, such as
[MkDocs](http://www.mkdocs.org/), [Pelican](http://blog.getpelican.com/), and
[Nikola](https://getnikola.com/) 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](https://github.com/jawher/markdown-dot),
which renders the dot graph to a file instead of inline.# License
[MIT License](http://www.opensource.org/licenses/mit-license.php)