8000 explain ditaa integration. · saliormoon/arangodb@3294708 · GitHub
[go: up one dir, main page]

Skip to content

Commit 3294708

Browse files
committed
explain ditaa integration.
1 parent 4a91176 commit 3294708

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README_maintainers.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -518,6 +518,14 @@ you need to place hooks:
518518
is replaced in with its own evaluated content - so *@EXAMPLE_ARANGOSH_[OUTPUT | RUN]* sections are executed
519519
the same way as inside of source code documentation.
520520

521+
Include ditaa diagrams
522+
----------------------
523+
We use the [beautifull ditaa (DIagrams Through Ascii Art)](http://ditaa.sourceforge.net/) to generate diagrams explaining flows etc.
524+
in our documentation.
525+
526+
We have i.e. `Manual/Graphs/graph_user_in_group.ditaa` which is transpiled by ditaa into a png file, thus you simply include
527+
a png file of the same name as image into the mardown: `![User in group example](graph_user_in_group.png)` to reference it.
528+
521529
Read / use the documentation
522530
----------------------------
523531
- `file:///Documentation/Books/books/Manual/index.html` contains the generated manual

0 commit comments

Comments
 (0)
0