一、文本
样式 | 语法 | 备注 |
---|
标题 | N个# + 空格 + 标题 | 标题最多6级, |
高亮 | *号包裹加粗或倾斜 | *斜体,**粗体,***粗斜体 |
引用 | 可用>前缀表示引用 | 其中N没有限制 |
上下角标 | 角标用sup,sub标签 | X2, logN |
超链接 | [链接名](链接地址 '链接title') | 去底部 |
代码 | `包裹单行代码,```包裹代码块 | ```独占一行,可带开发语言 |
公式 | 居左$ x=y^2 $ , 居中$$ x=y^2 $$ |
x
=
−
b
±
b
2
−
4
a
c
2
a
.
x = {-b \pm \sqrt{b^2 - 4ac } \over 2a}.
x=2a−b±b2−4ac
. |
二、表格
列表 | 语法 |
---|
无序列表 | *, -, + 任一种 + 空格 + 内容 |
有序列表 | 数字 + 空格 + 内容 |
列表嵌套 | 下一级比上一级缩进3个空格 |
三、图文混合
引用图片: ![图片alt](图片地址 '图片title')
流程图
- 定义参数:
标签名=>标签类型: 标签描述
- 连接参数:
标签A->标签2(yes|no, top|right|down|left)
标签类型 | 含义 |
---|
start | 流程开始 |
end | 流程结束 |
operation | 处理 |
subroutine | 子程序 |
condition | 条件,连接时可以加yes或no |
inputoutput | 输出 |
时序图
- 实体通信:
实体A->实体B: 通信描述
通信描述可省略,但:不可以省略 - 注释描述:
Note left|right of 实体X: 注释文本
代表注释在实体X的旁边
通信符号 | 含义 |
---|
- | 实线:主动请求 |
– | 虚线:请求返回 |
> | 实心箭头:同步消息 |
>> | 空心箭头:异步消息 |