目录
文字排版
标题
- 如果想将一段文字定义为标题,只需要在这段文字前面加上 #,再在 # 后加一个空格即可。
- 还可增加二、三、四、五、六级标题,总共六级,只需要增加 # ,增加一个 # ,标题字号相应降低一级
引用
-
这是一段引用
字体
- 斜体
- 粗体
链接图片
分割线
代码高亮
```
#include <stdio.h>
void main()
{
printf("Hello World\n");
return 0;
}
```
图表
流程图
- 说明
- TB - top bottom(自上而下)
- BT - bottom top(自下而上)
- RL - right left(从右到左)
- LR - left right(从左到右)
- 形状
- id[描述] 以直角矩形绘制
- id(描述) 以圆角矩形绘制
- id{描述} 以菱形绘制
- id>描述] 以不对称矩形绘制
- id((描述)) 以圆形绘制
- 箭头
- A–>B 带箭头指向
- A—B 不带箭头连接
- A-.-B 虚线连接
- A-.->B 虚线指向
- A==>B 加粗箭头指向
- 实例
时序图
- 语法
- Title:标题 :指定时序图的标题
- Note direction of 对象:描述 : 在对象的某一侧添加描述,direction 可以为 right/left/over , 对象 可以是多个对象,以 , 作为分隔符
- participant 对象 :创建一个对象
- loop…end :创建一个循环体
- 对象A->对象B:描述 : 绘制A与B之间的对话,以实线连接
- 箭头
- -> 实线实心箭头指向
- –> 虚线实心箭头指向
- ->> 实线小箭头指向
- –>> 虚线小箭头指向
- 实例
甘特图
-
说明
dateFormat YYYY-MM-DD规定了时间轴,title (标题文本)表示甘特图标题。
如需按项目进行划分,需键入section,空一个字符,再输入项目名称的文本(一个section和另一个section之间要空行)。 -
语法
- 在开头使用关键字 gantt 指明
- deteFormat 格式 指明日期的显示格式
- title 标题 设置图标的标题
- section 描述 定义纵向上的一个环节
- 定义步骤:每个步骤有两种状态 done(已完成)/ active(执行中)
- 描述
- 描述: 状态,id,开始日期,结束日期/持续时间
- 描述: 状态[,id],after id2,持续时间
- crit :可用于标记该步骤需要被修正,将高亮显示
- 如果不指定具体的开始时间或在某个步骤之后,将默认依次顺序排列
- 实例
- 表格
header 1 | header 2 | header 3 |
---|---|---|
row 1 col 1 | row 1 col 2 | row 1 col 3 |
row 2 col 1 | row 2 col 2 | row 2 col 3 |
Todo List
TOOD
- 完成1
- 完成2
- 未完成1
- 未完成2