本主题已支持 Mermaid
实现以纯文本的方式绘制流程图、序列图、甘特图、状态图、关系图行等等,随着 Mermaid
也在逐步发展,后续还会有各种各样的图被引入进来,更多的类型及使用方式可关注其官方网站:
https://mermaid-js.github.io/
。
使用说明
通过 hugo new
命令创建一篇新的文章 使用短代码书写各种类型的图,自带2个参数: align(对齐) 和 bc(背景色),可参考如下使用示例 流程图
1
2
3
4
5
6
7
{{ < mermaid align = "left" >}}
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
{{ < /mermaid >}}
时序图
1
2
3
4
5
6
7
8
9
10
11
12
13
{{ < mermaid bc = "#eee" >}}
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!
{{ < /mermaid >}}
John Bob Alice John Bob Alice loop [Healthcheck] Rational thoughts prevail! Hello John, how are you? 1 Fight against hypochondria 2 Great! 3 How about you? 4 Jolly good! 5 类图
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{{ < mermaid >}}
classDiagram
Class01 <| -- AveryLongClass : Cool
Class03 *-- Class04
Class05 o-- Class06
Class07 .. Class08
Class09 --> C2 : Where am i?
Class09 --* C3
Class09 --| > Class07
Class07 : equals()
Class07 : Object[] elementData
Class01 : size()
Class01 : int chimp
Class01 : int gorilla
Class08 <--> C2: Cool label
{{ < /mermaid >}}
Cool
Where am i?
Cool label
Class01
int chimp
int gorilla
size()
AveryLongClass
Class03
Class04
Class05
Class06
Class07
Object[] elementData
equals()
Class08
Class09
C2
C3
甘特图
1
2
3
4
5
6
7
8
9
10
11
12
{{ < mermaid >}}
gantt
dateFormat YYYY-MM-DD
title Adding GANTT diagram to mermaid
excludes weekdays 2014-01-10
section A section
Completed task :done, des1, 2014-01-06,2014-01-08
Active task :active, des2, 2014-01-09, 3d
Future task : des3, after des2, 5d
Future task2 : des4, after des3, 5d
{{ < /mermaid >}}
2014-01-07 2014-01-09 2014-01-11 2014-01-13 2014-01-15 2014-01-17 2014-01-19 2014-01-21 2014-01-23 Completed task Active task Future task Future task2 A section Adding GANTT diagram to mermaid 实体关系图
1
2
3
4
5
6
{{ < mermaid >}}
erDiagram
CUSTOMER || --o{ ORDER : places
ORDER || --| { LINE-ITEM : contains
CUSTOMER } | ..| { DELIVERY-ADDRESS : uses
{{ < /mermaid >}}
CUSTOMER ORDER LINE-ITEM DELIVERY-ADDRESS places contains uses 用户旅程
1
2
3
4
5
6
7
8
9
10
11
{{ < mermaid >}}
journey
title My working day
section Go to work
Make tea: 5: Me
Go upstairs: 3: Me
Do work: 1: Me, Cat
section Go home
Go downstairs: 5: Me
Sit down: 5: Me
{{ < /mermaid >}}
Cat Me Go to work Me Make tea Me Go upstairs Me Cat Do work Go home Me Go downstairs Me Sit down My working day