Skip to content

Commit f51c6f0

Browse files
committed
Update README.adoc
1 parent c5b60a9 commit f51c6f0

File tree

3 files changed

+47
-0
lines changed

3 files changed

+47
-0
lines changed

README.adoc

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ image::images/asciidocfx.png[]
2727
* Table Generator
2828
* MathJax Extension
2929
* PlantUML Extension
30+
* Mermaid Extension (Experimental)
3031
* ditaa Extension
3132
* Filesystem Tree Extension
3233
* JavaFX Charts Extension
@@ -192,6 +193,52 @@ image::images/uml-example.png[]
192193

193194
NOTE: In some UML elements, PlantUML needs to work with Graphviz. Because of this, you should install `Graphviz` manually for your platform. After installing Graphviz, you should set `GRAPHVIZ_DOT` environment variable to `dot` executable in Graphviz.
194195

196+
== Mermaid Extension (Experimental)
197+
198+
[quote,Rūmī]
199+
____
200+
Mermaid lets you create diagrams using text and code. This simplifies the maintenance of complex diagrams. **See more examples**: https://mermaid-js.github.io/
201+
____
202+
203+
[source,asciidoc]
204+
----
205+
[mermaid,images/mermaid-graph,png]
206+
--
207+
graph TD
208+
A[Start] --> B{Is it?};
209+
B -- Yes --> C[OK];
210+
C --> D[Rethink];
211+
D --> B;
212+
B -- No ----> E[End];
213+
--
214+
----
215+
216+
image::images/mermaid-graph.png[]
217+
218+
219+
[source,asciidoc]
220+
----
221+
[mermaid,file="images/mermaid-flowchart.png"]
222+
--
223+
flowchart TB
224+
c1-->a2
225+
subgraph one
226+
a1-->a2
227+
end
228+
subgraph two
229+
b1-->b2
230+
end
231+
subgraph three
232+
c1-->c2
233+
end
234+
one --> two
235+
three --> two
236+
two --> c2
237+
--
238+
----
239+
240+
image::images/mermaid-flowchart.png[]
241+
195242
== ditaa Extension
196243

197244
AsciidocFX supports ditaa diagrams.

images/mermaid-flowchart.png

10.1 KB
Loading

images/mermaid-graph.png

12.1 KB
Loading

0 commit comments

Comments
 (0)