mirror of
https://github.com/imfing/hextra.git
synced 2025-09-16 06:06:50 -04:00
83f3b5052e
* chore(docs): rename `exampleSite` to `docs` and create `examples` * chore(build): update build script to support new version format and source directories; add v0.10 to documentation menu
54 lines
1.1 KiB
Markdown
54 lines
1.1 KiB
Markdown
---
|
|
title: Diagrams
|
|
weight: 6
|
|
next: /docs/guide/shortcodes
|
|
---
|
|
|
|
Currently, Hextra supports [Mermaid](#mermaid) for diagrams.
|
|
|
|
<!--more-->
|
|
|
|
## Mermaid
|
|
|
|
[Mermaid](https://github.com/mermaid-js/mermaid#readme) is a JavaScript based diagramming and charting tool that takes Markdown-inspired text definitions and creates diagrams dynamically in the browser. For example, Mermaid can render flow charts, sequence diagrams, pie charts and more.
|
|
|
|
Using Mermaid in Hextra is as simple as writing a code block with language set `mermaid`:
|
|
|
|
````markdown
|
|
```mermaid
|
|
graph TD;
|
|
A-->B;
|
|
A-->C;
|
|
B-->D;
|
|
C-->D;
|
|
```
|
|
````
|
|
|
|
will be rendered as:
|
|
|
|
```mermaid
|
|
graph TD;
|
|
A-->B;
|
|
A-->C;
|
|
B-->D;
|
|
C-->D;
|
|
```
|
|
|
|
Sequence diagram:
|
|
|
|
```mermaid
|
|
sequenceDiagram
|
|
participant Alice
|
|
participant Bob
|
|
Alice->>John: Hello John, how are you?
|
|
loop Healthcheck
|
|
John->>John: Fight against hypochondria
|
|
end
|
|
Note right of John: Rational thoughts <br/>prevail!
|
|
John-->>Alice: Great!
|
|
John->>Bob: How about you?
|
|
Bob-->>John: Jolly good!
|
|
```
|
|
|
|
For more information, please refer to [Mermaid Documentation](https://mermaid-js.github.io/mermaid/#/).
|