mermaid学习

  1. mermaid
    1. mermaid是什么?
    2. 为什么使用?
  2. 常用
    1. 流程图-flowchart
      1. 方向
      2. 节点
    2. 时序图-sequenceDiagram
    3. 饼图-pie
    4. 状态图-stateDiagram
    5. 象限图

mermaid

Mermaid 是一种使用文本生成流程图、饼状图、甘特图等图表的描述语言,它可以帮助用户以简单、直观的方式创建各种类型的图表,包括流程图、时序图、甘特图等。

mermaid是什么?

Mermaid 是一种开源的文本驱动图表生成工具

Mermaid 的优点是它的 简单性可移植性

用户可以轻松地将其图表定义嵌入到任何支持 HTML、Markdown 或 AsciiDoc 的文档中,

官方教程:

在线编辑器:

online-edit

为什么使用?

现代工程协作 + 文档即代码(Docs as Code)

比起使用 draw.io 心智负担更小,文本描述流程,方便使用Git管理

战未来:

  • 在LLM时代,文本就是第一公民,markdown在LLM时代就是标准
  • 用文本来绘图,对大模型可太友好了。

常用

流程图-flowchart

文档:

关键词 flowchart OR graph

be like:

flowchart LR

    id[id]

方向

graph LR

	a[左] --> b[右]
graph LR

	a[左] --> b[右]

graph TD

	a[上] --> b[下]
graph TD

	a[上] --> b[下]

节点

  1. 长方形
flowchart LR

	id[长方形]
flowchart LR

	id[长方形]

  1. 长方形+圆倒角
flowchart LR

	id(长方形+圆角)
flowchart LR

	id(长方形+圆角)

  1. 圆形
flowchart LR

	id((圆形))
flowchart LR

	id((圆形))

  1. 圆柱形
flowchart LR

	id[(圆柱形)]
flowchart LR

	id[(圆柱形)]

  1. 菱形
flowchart LR

    id1{菱形}
flowchart LR

    id1{菱形}

  1. 平行四边形
flowchart TD

    id1[/平行四边形/]

flowchart TD

    id1[/平行四边形/]

时序图-sequenceDiagram

时序图是一种交互图,它展示了各个过程如何相互操作以及操作的顺序。

文档:

sequenceDiagram
    Alice->>John: Hello John, how are you?
    John-->>Alice: Great!
    Alice-->>John: See you later!

饼图-pie

pie title Pets adopted by volunteers
    "Dogs" : 386
    "Cats" : 85
    "Rats" : 15

状态图-stateDiagram

stateDiagram-v2
    [*] --> Still
    Still --> [*]

    Still --> Moving
    Moving --> Still
    Moving --> Crash
    Crash --> [*]
# 表示从远点开始
[*] 

象限图

github