markdown绘图插件----mermaid简介

作者：黄永刚

mermaid简介

这里写图片描述

当撰写文档的时候，对于流程图的生成大多使用Visio等繁重的工具，没有一种轻便的工具能够画图从而简化文档的编写，就像markdown那样。

mermaid解决这个痛点，这是一个类似markdown语法的脚本语言，通过JavaScript实现图表的生成。
先来看个例子:

1.流程图(flowchart)

graph LR;  
　　A-->B;    
　　A-->C;  
　　B-->D;  
　　C-->D;

生成的图表如下所示：

这里写图片描述
2. 时序图(sequence diagram)

sequenceDiagramparticipant Aliceparticipant BobAlice->John:Hello John, how are you?loop HealthcheckJohn->John:Fight against hypochondriaendNote right of John:Rational thoughts <br/>prevail...John-->Alice:Great!John->Bob: How about you?Bob-->John: Jolly good!

生成的图表如下所示：

这里写图片描述

3.甘特图(gantt diagram)

ganttdateFormat　YYYY-MM-DDtitle Adding GANTT diagram functionality to mermaidsection A sectionCompleted task　　:done, des1, 2014-01-06,2014-01-08Active task 　　　　:active, des2, 2014-01-09, 3dfuture task 　　　　:　　　  des3, after des2, 5dfuture task2　　　　:　　　  des4, after des3, 5dsection Critical tasksCompleted task in the critical line　:crit, done, 2014-01-06,24hImplement parser and json　　　　　　:crit, done, after des1, 2dCreate tests for parser　　　　　　　:crit, active, 3dFuture task in critical line　　　　　:crit, 5dCreate tests for renderer　　　　　　:2dAdd to ,mermaid　　　　　　　　　　　:1d

生成的表如下：

这里写图片描述

下游项目

Mermaid 是由Knut Sveidqbist发起旨在轻便化的文档撰写。所有开发者:开发者列表

Gitbook-plugin
Light table
Confluence plugin
Using mermaid via docpad
Using mermaid in Jekvll
Using mermaid via Octopress
Mardown editor Haroopad
Plugin for atom
Markdown Plus
LightPaper 1.2+
Vim Plugin
以上的这些都有集成mermaid或者开发相关的插件。

Graph

graph LRA --> B

这里写图片描述
这是申明一个由左到右，水平向右的图。\
可能方向有：
- TB - top bottom
- BT - bottom top
- RL - right left
- LR - left right
- TD - same as TB

节点与形状

默认节点

graph LR
id1

注意：’id’显示在节点内部。

文本节点

这里写图片描述

graph LR
id[This is the text in the box];

圆角节点

这里写图片描述

graph LR
id(This is the text in the box);

圆节点(The form of a circle)

这里写图片描述

graph LR
id((This is the text in the circle));

非对称节点(asymetric shape)

这里写图片描述

graph LR
id>This is the text in the box]

菱形节点(rhombus)

这里写图片描述

graph LR
id{This is the text in the box}

连接线

节点间的连接线有多种形状，而且可以在连接线中加入标签：

箭头形连接

这里写图片描述

graph LR;A-->B;

开放行连接

graph LR
A --- B

标签连接

这里写图片描述

graph LR
A -- This is the label text --- B;

箭头标签连接

A–>|text|B\
或者\
A– text –>B

这里写图片描述

graph LRA-- text -->B

虚线(dotted link,点连线)

-.->

这里写图片描述

graph LR
A-.->B

-.-.

这里写图片描述

graph LR
A-.-.B

标签虚线

-.text.->

graph LR
A-.text.->B

这里写图片描述

粗实线

==>

graph LR
A==>B

这里写图片描述

===

graph LR
A===B

这里写图片描述

标签粗线

=\=text\==>

graph LR
A==text==>B

这里写图片描述

=\=text\===

graph LR
A==text===B

这里写图片描述

特殊的语法

使用引号可以抑制一些特殊的字符的使用，可以避免一些不必要的麻烦。

graph LR\
d1[“This is the (text) in the box”]

graph LR
d1["This is the (text) in the box"]

这里写图片描述

html字符的转义字符

转义字符的使用语法：
流程图定义如下：

graph LR\
A[“A double quote:#quot;”] –> B[“A dec char:#9829;”]

渲染后的图如下：
这里写图片描述

graph LRA["A double quote:#quot;"]-->B["A dec char:#9829;"]

子图(Subgraphs)

subgraph title\
graph definition\
end

示例：

graph TBsubgraph onea1 --> a2ensubgraph twob2 --> b2endsubgraph threec1 --> c2endc1 --> a2

结果：

这里写图片描述

基础fontawesome支持

如果想加入来自frontawesome的图表字体,需要像frontawesome网站上那样引用的那样。\
详情请点击：fontawdsome

引用的语法为：++fa:#icon class name#++

graph TDB["fa:fa-twitter for peace"]B-->C[fa:fa-ban forbidden]B-->D(fa:fa-spinner);B-->E(A fa:fa-camerra-retro perhaps?);

渲染图如下：

graph TDB["fa:fa-twitter for peace"]B-->C[fa:fa-ban forbidden]B-->D(fa:fa-spinner);B-->E(A fa:fa-camera-retro perhaps?);

这里写图片描述

以上reference：
1.mermaid docs

第二部分—图表(graph)

定义连接线的样式

graph LRid1(Start)-->id2(Stop)style id1 fill:#f9f,stroke:#333,stroke-width:4px;style id2 fill:#ccf,stroke:#f66,stroke-width:2px,stroke-dasharray:5,5;

渲染结果：

这里写图片描述

graph LRid1(Start)-->id2(Stop)style id1 fill:#f9f,stroke:#333,stroke-width:4px;style id2 fill:#ccf,stroke:#f66,stroke-width:2px,stroke-dasharray:5,5;

备注：这些样式参考CSS样式。

样式类

为了方便样式的使用，可以定义类来使用样式
类的定义示例：

classDef className fill:#f9f,stroke:#333,stroke-width:4px;

对节点使用样式类：

class nodeId className;

同时对多个节点使用相同的样式类：

class nodeId1,nodeId2 className;

可以在CSS中提前定义样式类，应用在图表的定义中。

graph LRA-->B[AAABBB];B-->D;class A cssClass;

默认样式类：\
当没有指定样式的时候，默认采用。

classDef default fill:#f9f,stroke:#333,stroke-width:4px;

示例：

graph LRclassDef default fill:#f90,stroke:#555,stroke-width:4px;id1(Start)-->id2(Stop)

结果：

graph LR
classDef default fill:#f90,stroke:#555,stroke-width:4px;
id1(Start)-->id2(Stop)

序列图(sequence diagram)1

序列图

示例：

sequenceDiagramAlice->>John: Hello John, how are you ?John-->>Alice: Great!Alice--->>John: Huang,you are better .John-->>Alice: yeah, Just not bad.

sequenceDiagramAlice->>John: Hello John, how are you ?John-->>Alice: Great!Alice->>John: Hung,you are better .John-->>Alice: yeah, Just not bad.

这里写图片描述
观察上面的图，如果想让John出现在前面，如何控制，mermaid通过设定参与者(participants)的顺序控制二者的顺序。上面的图可以做如下修改：

sequenceDiagram\
　　participant John\
　　participant Alice\
　　Alice->>John:Hello John,how are you?\
　　John–>>Alice:Great!

sequenceDiagramparticipant Johnparticipant AliceAlice-xJohn:Hello John,how are you?John-->>Alice:Great!

这里写图片描述
消息的语法：
　　实线或者虚线的使用：
[Actor][Arrow][Actor]:Message text\
Arrow的六种样式：

->
–>
->>
–>>
-x
–x

示例：

sequenceDiagramAlice->John: Hello John, how are you ?John-->Alice:Great!Alice->>John: dont borther me !John-->>Alice:Great!Alice-xJohn: wait!John--xAlice: Ok!

这里写图片描述

便签

给序列图增加便签：\
具体规则：\
[right of | left of | over][Actor]:Text\
示例：

sequenceDiagramparticipant JohnNote left of John: Text in note

结果：

这里写图片描述

跨越两个Actor的便签：

sequenceDiagramAlice->John:Hello John, how are you?Note over Alice,John:A typical interaction

sequenceDiagram
Alice->>John:Hello John, how are you?
Note over Alice,John:A typical interaction

这里写图片描述

循环Loops

在序列图中，也可以使用循环，具体规则如下：

loop Loop text
... statements...
end

示例：

sequenceDiagramAlice->>John: Hello!loop Reply every minuteJohn->>Alice:Great!end

渲染结果：

这里写图片描述

选择ALT

在序列图中选择的表达。规则如下：

alt Describing text
...statements...
else
...statements...
end

或者使用opt(推荐在没有else的情况下使用)

opt Describing text
...statements...
end

示例：

sequenceDiagramAlice->>Bob: Hello Bob, how are you?alt is sickBob->>Alice:not so good :(else is wellBob->>Alice:Feeling fresh like a daisy:)endopt Extra responseBob->>Alice:Thanks for askingend

渲染结果如下：

这里写图片描述

甘特图(gantt)2

甘特图是一类条形图，由Karol Adamiechi在1896年提出, 而在1910年Henry Gantt也独立的提出了此种图形表示。通常用在对项目终端元素和总结元素的开始及完成时间进行的描述。

示例：

gantt
dateFormat YYYY-MM-DDsection S1
T1: 2014-01-01, 9dsection S2
T2: 2014-01-11, 9dsection S3
T3: 2014-01-02, 9d

gantt
dateFormat YYYY-MM-DD
section S1
T1: 2014-01-01, 9d
section S2
T2: 2014-01-11, 9d
section S3
T3: 2014-01-02, 9d

这里写图片描述

先来看一个大的例子：

    ganttdateFormat  YYYY-MM-DDtitle Adding GANTT diagram functionality to mermaidsection A sectionCompleted task            :done,    des1, 2014-01-06,2014-01-08Active task               :active,  des2, 2014-01-09, 3dFuture task               :         des3, after des2, 5dFuture task2               :         des4, after des3, 5dsection Critical tasksCompleted task in the critical line :crit, done, 2014-01-06,24hImplement parser and jison          :crit, done, after des1, 2dCreate tests for parser             :crit, active, 3dFuture task in critical line        :crit, 5dCreate tests for renderer           :2dAdd to mermaid                      :1dsection DocumentationDescribe gantt syntax               :active, a1, after des1, 3dAdd gantt diagram to demo page      :after a1  , 20hAdd another diagram to demo page    :doc1, after a1  , 48hsection Last sectionDescribe gantt syntax               :after doc1, 3dAdd gantt diagram to demo page      : 20hAdd another diagram to demo page    : 48h

获得的图渲染后如下：
这里写图片描述

header 1	header 2
title	标题
dateFormat	日期格式
section	模块
Completed	已经完成
Active	当前正在进行
Future	后续待处理
crit	关键阶段
日期缺失	默认从上一项完成后

关于日期的格式可以参考：
- string-format
- Time-Formatting

Demo

graph TBsq[Square shape] --> ci((Circle shape))subgraph A subgraphdi{Diamond with  line break} -.-> ro(Rounded)di==>ro2(Rounded square shape)ende --> od3>Really long text with linebreak<br>in an Odd shape]cyr[Cyrillic]-->cyr2((Circle shape Начало));classDef green fill:#9f6,stroke:#333,stroke-width:2px;classDef orange fill:#f96,stroke:#333,stroke-width:4px;class sq,e greenclass di orange