path: root/ikiwiki/directive/graph.mdwn
diff options
Diffstat (limited to 'ikiwiki/directive/graph.mdwn')
1 files changed, 24 insertions, 0 deletions
diff --git a/ikiwiki/directive/graph.mdwn b/ikiwiki/directive/graph.mdwn
new file mode 100644
index 0000000..7473d3e
--- /dev/null
+++ b/ikiwiki/directive/graph.mdwn
@@ -0,0 +1,24 @@
+The `graph` directive is supplied by the [[!iki plugins/graphviz
+desc=graphviz]] plugin.
+This directive allows embedding [graphviz]( graphs
+in a page. Example usage:
+ \[[!graph src="a -> b -> c; a -> c;"]]
+Note that graphs will only show up in previews if your browser has
+[[!wikipedia data: URI]] support, or if the same graph already exists on
+that page.
+The `graph` directive supports the following parameters:
+- `src` - The graphviz source to render.
+- `type` - The type of graph to render: `graph` or `digraph`. Defaults to
+ `digraph`.
+- `prog` - The graphviz program to render with: `dot`, `neato`, `fdp`,
+ `twopi`, or `circo`. Defaults to `dot`.
+- `height`, `width` - Limit the size of the graph to a given height and
+ width, in inches. You must specify both to limit the size; otherwise,
+ graphviz will choose a size, without any limit.
+[[!meta robots="noindex, follow"]]