markdown-Mermaid语法整理

Mermaid是一种用于创建图表的简单标记语言,常用于Markdown中。本文详细介绍了Mermaid的语法,包括不同类型的图(如流程图、序列图、饼状图等),节点样式,连接线样式以及子图的创建。同时,提到了如何使用特殊语法和样式来定制图表的外观,并给出了多个示例。此外,还提供了参考资料以便进一步学习。

Mermaid语法

语法:

```mermaid 内容 ```

例子:

Start
Stop

graph TD:

TD表示画一张自上而下的图(Top-Down), 自左而右为graph LR

格式:

节点名[显示内容]–关联词->节点名[显示内容],->表示箭头方向已经被定义的节点可以直接使用,可以省略[显示内容]

格式:

class节点名(中间用英文逗号隔开)internal-link

方向:

TB/TD - top bottom
BT - bottom top
eRL - right left
LR - left right

节点:

□-方形文本框
1-菱形文本框
() -边角圆滑文本框
((""))-圆形文本框
1.id[带文字节点]
2.id((圆形节点))
3.id(菱形节点
4.id(圆角节点)
5.id>不对称节点]

连接线:

—:实线
-.-:虚线
===:粗线

1.实线,有箭头,文字:A–文字–>B
2.虚线,有箭头,文字:A.文字.->B
3.大箭头,文字:A文字>B
4.实线,有箭头,无文字:A–>B
5.大箭头,无文字:A==>B
6.实线,无箭头,文字:A–文字—B
7.实线,无箭头,无文字:A–B
8.虚线,箭头,无文字:A–>B

特殊语法:
引号:用来转义;

子图:

subgraph 子图标题
a1 --> a2
end

样式:

linkStyle
linkStyle O stroke:#0ff,stroke-width:2px; 蓝色
黑色:#000
红色:#F00
绿色:#OFO
蓝色:#OOF
黄色:#FFO
青色:#OFF
紫色:#FOF
灰色:#888
白色:#FFF
默认样式集:
classDef default fill:#ff0,stroke:#888,stroke-width:2px;
节点背景、边框颜色、粗细

  • Mermaid能绘制哪些图?
  • 饼状图:使用pie关键字,具体用法后文将详细介绍
  • 流程图:使用graph关键字,具体用法后文将详细介绍
  • 序列图:使用sequenceDiagram关键字
  • 甘特图:使用gantt关键字
  • 类图:使用classDiagram关键字
  • 状态图:使用stateDiagram关键字
  • 用户旅程图:使用journey关键字

例子:

  • 注释:在行首加入%%即可。
Link text
One
Two
Hard edge
Round edge
Decision
Result one
Result two
默认方形
方形
圆边矩形
体育场形
子程序形
圆柱形
圆形
Yes
No
Start
Is it?
OK
Rethink
End
3%4%93%为什么总是宅在家里?喜欢宅天气太热或太冷
长子
长子
次子
次子
三子
四子
长子
朱八八
朱五四
朱四九
朱百六
朱雄英
朱标
朱允炆
朱樉
朱棡
朱棣
朱高炽
three
one
c2
c1
two
b2
b1
a2
a1

参考:
https://mermaid-js.github.io/mermaid/#/
https://zhuanlan.zhihu.com/p/355997933
https://www.cnblogs.com/luomit/p/13874158.html

### 关于 `markdown-it-mermaid` 的安装、使用与配置 #### 安装指南 为了集成 `markdown-it-mermaid` 到项目中,需先通过 npm 或 yarn 进行包管理工具来安装必要的库。具体命令如下: 对于 npm 用户而言, ```bash npm install markdown-it mermaid markdown-it-mermaid --save ``` 而对于偏好 yarn 的开发者来说,则应执行: ```bash yarn add markdown-it mermaid markdown-it-mermaid ``` 上述操作会下载并保存这些依赖到项目的 node_modules 文件夹下[^1]。 #### 初始化设置 完成安装之后,在 JavaScript 中初始化 `markdown-it` 实例并向其中混入 `markdown-it-mermaid` 插件是必需的操作。下面是一段简单的示例代码用于展示如何实现这一点: ```javascript const md = require('markdown-it')(); require('markdown-it-mermaid')(md); // 如果希望自定义样式或者调整默认行为, 可在此处传入选项对象作为参数传递给插件函数. ``` 这段脚本创建了一个新的 `markdown-it` 解析器实例,并注册了支持 Mermaid 图表语法的功能扩展[^2]。 #### 使用方法及选项配置 当一切准备就绪后,便可以在 Markdown 文档里编符合 Mermaid 语法规则的内容片段以生成图表。例如绘制一个序列图可以这样: ```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! ``` 值得注意的是,如果想要进一步定制化渲染效果或是修改某些特定的行为模式,可以通过向 `markdown-it-mermaid` 构造函数提供额外的配置项来进行微调。更多细节可查阅官方文档获取完整的属性列表及其含义[^3]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值