From 6b252dbc87462a5ccfd31c8fc6c27195646365dd Mon Sep 17 00:00:00 2001
From: Johannes Stoelp <johannes.stoelp@gmail.com>
Date: Sat, 25 Jun 2022 21:52:54 +0200
Subject: [dot]: added copy & paste dot example graph

---
 src/tools/dot.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)
 create mode 100644 src/tools/dot.md

(limited to 'src/tools/dot.md')

diff --git a/src/tools/dot.md b/src/tools/dot.md
new file mode 100644
index 0000000..d3d7ac8
--- /dev/null
+++ b/src/tools/dot.md
@@ -0,0 +1,54 @@
+# dot(1)
+
+Example `dot` file to copy & paste from.
+
+Can be rendered to `svg` with the following command.
+```bash
+dot -T svg -o g.svg g.dot
+```
+
+Example `dot` file.
+```dot
+// file: g.dot
+digraph {
+    // Render ranks from left to right.
+    rankdir=LR
+    // Make background transparent.
+    bgcolor=transparent
+
+    // Global node attributes.
+    node [shape=box]
+    // Global edge attributes.
+    edge [style=dotted,color=red]
+
+    // Add nodes & edge.
+    stage1 -> stage2
+    // Add multiple edges at once.
+    stage2 -> { stage3_1, stage3_2 }
+    // Add edge with custom attributes.
+    stage3_2 -> stage4 [label="some text"]
+
+    // Set custom attributes for specific node.
+    stage4 [color=green,fillcolor=lightgray,style="filled,dashed",label="s4"]
+
+    // Create a subgraph. This can be used to group nodes/edges or as scope for
+    // global node/edge attributes.
+    // If the name starts with 'cluster' a border is drawn.
+    subgraph cluster_1 {
+        stage5_1
+        stage5_2
+    }
+
+    // Add some edges to subgraph nodes.
+    stage3_1 -> { stage5_1, stage5_2 }
+}
+```
+
+Rendered `svg` file.
+![g.svg](/assets/g.svg)
+
+## References
+- [DOT language](https://graphviz.org/doc/info/lang.html)
+- [Attributes](https://graphviz.org/doc/info/attrs.html)
+- [Node shapes](https://graphviz.org/doc/info/shapes.html)
+- [Colors](https://graphviz.org/doc/info/colors.html)
-- 
cgit v1.2.3