Skip to content

Commit 83221ea

Browse files
committed
Update public notes
1 parent c4c1e63 commit 83221ea

File tree

1 file changed

+175
-0
lines changed

1 file changed

+175
-0
lines changed
Lines changed: 175 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,175 @@
1+
---
2+
created: "2025-12-24"
3+
updated: "2025-12-24"
4+
---
5+
> [!WARNING]
6+
> 本文主要内容由 AI 生成,如有介意请不要观看此页面。
7+
8+
Mermaid 是一种基于 Markdown 的图表绘制工具,它允许你使用简单的文本代码生成流程图、时序图、甘特图等。对于开发者和文档撰写者来说,它是实现“文档即代码”(Documentation as Code)的神器。
9+
10+
## 基础语法结构
11+
12+
Mermaid 的代码块通常包裹在 Markdown 的代码围栏中:
13+
14+
```
15+
graph LR
16+
%% 这是一个注释
17+
A[开始] --> B[结束]
18+
```
19+
20+
```mermaid
21+
graph LR
22+
%% 这是一个注释
23+
A[开始] --> B[结束]
24+
```
25+
26+
**常用方向标识:**
27+
- **TB / TD**: 从上到下 (Top to Bottom / Top Down)
28+
- **BT**: 从下到上 (Bottom to Top)
29+
- **LR**: 从左到右 (Left to Right)
30+
- **RL**: 从右到左 (Right to Left)
31+
32+
## 核心图表类型
33+
34+
### 流程图
35+
36+
```
37+
graph LR
38+
A[矩形] --> B(圆角矩形)
39+
B --> C{决策判断}
40+
C -- 是 --> D((圆形))
41+
C -- 否 --> E>旗帜形]
42+
```
43+
44+
```mermaid
45+
graph LR
46+
A[矩形] --> B(圆角矩形)
47+
B --> C{决策判断}
48+
C -- 是 --> D((圆形))
49+
C -- 否 --> E>旗帜形]
50+
```
51+
52+
- **节点形状**`[]` 矩形,`()` 圆角,`{}` 菱形,`(())` 圆形。
53+
- **连线**`-->` 实线箭头,`---` 实线无箭头,`-.->` 虚线箭头,==> 加粗箭头。
54+
55+
### 时序图
56+
57+
用于描述对象之间的交互顺序。
58+
59+
```
60+
sequenceDiagram
61+
participant 客户端
62+
participant 服务器
63+
客户端->>服务器: 发起 GET 请求
64+
服务器-->>客户端: 返回 200 OK
65+
Note right of 服务器: 服务器处理逻辑
66+
```
67+
68+
```mermaid
69+
sequenceDiagram
70+
participant 客户端
71+
participant 服务器
72+
客户端->>服务器: 发起 GET 请求
73+
服务器-->>客户端: 返回 200 OK
74+
Note right of 服务器: 服务器处理逻辑
75+
```
76+
77+
### 甘特图
78+
79+
```
80+
gantt
81+
title 项目开发计划
82+
dateFormat YYYY-MM-DD
83+
section 设计阶段
84+
需求分析 :a1, 2023-10-01, 5d
85+
原型设计 :after a1, 7d
86+
section 开发阶段
87+
后端开发 :2023-10-12, 10d
88+
前端开发 :2023-10-12, 10d
89+
```
90+
91+
```mermaid
92+
gantt
93+
title 项目开发计划
94+
dateFormat YYYY-MM-DD
95+
section 设计阶段
96+
需求分析 :a1, 2023-10-01, 5d
97+
原型设计 :after a1, 7d
98+
section 开发阶段
99+
后端开发 :2023-10-12, 10d
100+
前端开发 :2023-10-12, 10d
101+
```
102+
103+
## 进阶样式
104+
105+
### 箭头上写字
106+
107+
可以用这两种办法给箭头写字
108+
109+
```
110+
graph LR
111+
A -- 成功 --> B
112+
C -->|失败| D
113+
```
114+
115+
```mermaid
116+
graph LR
117+
A -- 成功 --> B
118+
C -->|失败| D
119+
```
120+
121+
### 一次连接多个节点
122+
123+
```
124+
graph LR
125+
A --> B & C --> D
126+
```
127+
128+
```mermaid
129+
graph LR
130+
A --> B & C --> D
131+
```
132+
133+
### 节点样式定制
134+
135+
你可以通过 `style` 关键字为特定节点着色:
136+
137+
```
138+
graph LR
139+
Start --> Stop
140+
style Start fill:#f9f,stroke:#333,stroke-width:4px
141+
style Stop fill:#bbf,stroke:#f66,stroke-dasharray: 5 5
142+
```
143+
144+
```mermaid
145+
graph LR
146+
Start --> Stop
147+
style Start fill:#f9f,stroke:#333,stroke-width:4px
148+
style Stop fill:#bbf,stroke:#f66,stroke-dasharray: 5 5
149+
```
150+
### 子图 (Subgraphs)
151+
152+
将相关的节点组织在一起:
153+
154+
```
155+
graph TB
156+
subgraph 外部系统
157+
A[用户界面]
158+
end
159+
subgraph 核心服务
160+
B[API层] --> C[数据库]
161+
end
162+
A --> B
163+
```
164+
165+
```mermaid
166+
graph LR
167+
subgraph 外部系统
168+
A[用户界面]
169+
end
170+
subgraph 核心服务
171+
B[API层] --> C[数据库]
172+
end
173+
A --> B
174+
```
175+

0 commit comments

Comments
 (0)