Use text like dot or seqdiag to render diagrams (eg. Graphviz or diagrams.js)
###TL;DR:
Diagrams of components, sequences, and workflows are hard to update, paragraphs are easy. Doc authors would benefit from the ability to describe flows in plain text and compile to graphics.
#Plugins for compiling text into graphics
In Sphinx this feature is available using https://www.sphinx-doc.org/en/master/usage/extensions/graphviz.html.
Graphviz is based on Java and widely available as a library for processing diagrams written in simple markups (with names like dot
and neato
).
The markup conventions have been adopted and extended by projects on other platforms such as viz.js and diagrams.js
####Graphviz references
####Alternatives
- Vis.js: Perhaps the most powerful of the NodeJS-based options, it supports multiple input languages.
- Mermaid.js
- Diagrams.js powers some other projects and IDE plugins.
- Viz.js Org Not the same as Vis.js
####Super cool, taking it to the next level...