1.后缀名
.md .markdown
2.标题
# 这是一级标题
## 这是二级标题
### 这是三级标题
#### 这是四级标题
##### 这是五级标题
###### 这是六级标题
显示效果:
这是一级标题
这是二级标题
这是三级标题
这是四级标题
这是五级标题
这是六级标题
3.字体
*斜体文本*
**粗体文本**
***粗斜体文本***
~~删除线~~
显示效果:
斜体文字
文字加粗
粗斜体文字
删除线
4.引用
>加引用文字
>>两层引用
>>>可多层引用
显示效果:
加引用文字
两层引用
可多层引用
加引用文字
两层引用
可多层引用
5.分割线
三个或者三个以上的 - 或者 * 都可以
---
***
显示效果:
6.超链接
1、[链接名称](链接地址) [我的博客](https://qingtianyin.github.io)
2、<链接地址> <https://qingtianyin.github.io>
3、高级链接
这个链接用 1 作为网址变量 [Google][1]
这个链接用 blog 作为网址变量 [blog][blog]
然后在文档的结尾为变量赋值(网址)
[1]: http://www.google.com/
[blog]: https://qingtianyin.github.io/
1、我的博客
2、https://qingtianyin.github.io
3、 这个链接用 1 作为网址变量 Google
这个链接用 blog 作为网址变量 blog
然后在文档的结尾为变量赋值(网址)
7.列表
Markdown 支持有序列表和无序列表。
无序列表使用*、+或-作为列表标记,这些标记后面要添加一个空格,然后再填写内容:
* 第一项
+ 第1项
+ 第2项
- First
- Second
- Third
显示效果:
- 第一项
- 第1项
- 第2项
- First
- Second
- Third
有序列表使用数字并加上 . 号来表示
1. 第一项
2. 第二项
3. 第三项
显示效果:
- 第一项
- 第二项
- 第三项
列表嵌套只需在子列表中的选项前面添加四个空格即可
1. 第一项:
- 第一项嵌套1
- 第一项嵌套2
2. 第二项:
- 第二项嵌套1
- 第二项嵌套2
显示效果:
-
第一项
- 第一项嵌套1
- 第一项嵌套2 -
第二项
- 第二项嵌套1
- 第二线嵌套2
8.表格
用 | 来分隔不同的单元格,使用 - 来分隔表头和其他行 (两边的|也可去掉)
| 姓名 | 性别 | 年龄 |
| --- | --- | --- |
| 菲奥娜| 女 | 26 |
|劫|男|未知|
显示效果:
姓名 | 性别 | 年龄 |
---|---|---|
菲奥娜 | 女 | 26 |
劫 | 男 | 未知 |
设置表格的对齐方式:
-: 设置内容和标题栏居右对齐。
:- 设置内容和标题栏居左对齐。
:-: 设置内容和标题栏居中对齐。
| 姓名 | 性别 | 年龄 |
| :--- | :---: | ---: |
| 菲奥娜| 女 | 26 |
|劫|男|未知|
显示效果:
姓名 | 性别 | 年龄 |
---|---|---|
菲奥娜 | 女 | 26 |
劫 | 男 | 未知 |
9.代码块
单行代码:代码之间分别用一个 反引号 ` 包起来
``System.out.println("我很帅");`
显示效果:
System.out.println("我很帅");
代码块:代码之间分别用三个反引号包起来,且两边的反引号单独占一行
```
int a = 1;
int value = 2;
value += a;
```
显示效果:
int a = 1;
int value = 2;
value += a;
10.图片
图片语法格式
1、![alt 属性文本](图片地址)
2、![alt 属性文本](图片地址 "可选标题")
开头一个感叹号 !
接着一个方括号,里面放上图片的替代文字
接着一个普通括号,里面放上图片的网址,最后还可以用引号包住并加上选择性的 'title' 属性的文字。
![cat 猫](https://i-blog.csdnimg.cn/blog_migrate/aa04c1e3366d06bdb9aabb7aae9ce63f.png)
![cat 猫](https://i-blog.csdnimg.cn/blog_migrate/aa04c1e3366d06bdb9aabb7aae9ce63f.png cat)
显示效果:
当然,你也可以像网址那样对图片网址使用变量:
这个链接用 1 作为网址变量 [cat][1].
然后在文档的结尾为变量赋值(网址)
[1]: https://i-blog.csdnimg.cn/blog_migrate/aa04c1e3366d06bdb9aabb7aae9ce63f.png
Markdown 还没有办法指定图片的高度与宽度,如果你需要的话,你可以使用普通的 <img> 标签。
<img src="https://i-blog.csdnimg.cn/blog_migrate/aa04c1e3366d06bdb9aabb7aae9ce63f.png" width="50%">
![](https://i-blog.csdnimg.cn/blog_migrate/aa04c1e3366d06bdb9aabb7aae9ce63f.png)
11.流程图
1、横向流程图源码格式
```mermaid
graph LR
A[方形] -->B(圆角)
B --> C{条件a}
C -->|a=1| D[结果1]
C -->|a=2| E[结果2]
F[横向流程图]
```
显示效果:
2、竖向流程图源码格式
```mermaid
graph TD
A[方形] --> B(圆角)
B --> C{条件a}
C --> |a=1| D[结果1]
C --> |a=2| E[结果2]
F[竖向流程图]
```
显示效果:
3、标准流程图源码格式
```mermaid
flowchat
st=>start: 开始框
op=>operation: 处理框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 结束框
st->op->cond
cond(yes)->io->e
cond(no)->sub1(right)->op
```
显示效果:
4、标准流程图源码格式(横向)
```mermaid
flowchat
st=>start: 开始框
op=>operation: 处理框
cond=>condition: 判断框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 输入输出框
e=>end: 结束框
st(right)->op(right)->cond
cond(yes)->io(bottom)->e
cond(no)->sub1(right)->op
```
显示效果:
*5、UML时序图源码样例:
```mermaid
sequenceDiagram
对象A->>对象B: 对象B你好吗?(请求)
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->>对象A: 我很好(响应)
对象A->>对象B: 你真的好吗?
```
显示效果:
*6、UML时序图源码复杂样例:
```mermaid
sequenceDiagram
Title: 标题:复杂使用
对象A->>对象B: 对象B你好吗?(请求)
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->>对象A: 我很好(响应)
对象B->>小三: 你好吗
小三-->>对象A: 对象B找我了
对象A->>对象B: 你真的好吗?
Note over 小三,对象B: 我们是朋友
participant C
Note right of C: 没人陪我玩
```
显示效果:
*7、UML标准时序图样例:
```mermaid
%% 时序图例子,-> 直线,-->虚线,->>实线箭头
sequenceDiagram
participant 张三
participant 李四
张三->王五: 王五你好吗?
loop 健康检查
王五->王五: 与疾病战斗
end
Note right of 王五: 合理 食物 <br/>看医生...
李四-->>张三: 很好!
王五->李四: 你怎么样?
李四-->王五: 很好!
```
显示效果:
*8、甘特图样例:
```mermaid
%% 语法示例
gantt
dateFormat YYYY-MM-DD
title 软件开发甘特图
section 设计
需求 :done, des1, 2014-01-06,2014-01-08
原型 :active, des2, 2014-01-09, 3d
UI设计 : des3, after des2, 5d
未来任务 : des4, after des3, 5d
section 开发
学习准备理解需求 :crit, done, 2014-01-06,24h
设计框架 :crit, done, after des2, 2d
开发 :crit, active, 3d
未来任务 :crit, 5d
耍 :2d
section 测试
功能测试 :active, a1, after des3, 3d
压力测试 :after a1 , 20h
测试报告 : 48h
```
显示效果:
%% 语法示例
gantt
dateFormat YYYY-MM-DD
title 软件开发甘特图
section 设计
需求 :done, des1, 2014-01-06,2014-01-08
原型 :active, des2, 2014-01-09, 3d
UI设计 : des3, after des2, 5d
未来任务 : des4, after des3, 5d
section 开发
学习准备理解需求 :crit, done, 2014-01-06,24h
设计框架 :crit, done, after des2, 2d
开发 :crit, active, 3d
未来任务 :crit, 5d
耍 :2d
section 测试
功能测试 :active, a1, after des3, 3d
压力测试 :after a1 , 20h
测试报告 : 48h
: des4, after des3, 5d
section 开发
学习准备理解需求 :crit, done, 2014-01-06,24h
设计框架 :crit, done, after des2, 2d
开发 :crit, active, 3d
未来任务 :crit, 5d
耍 :2d
section 测试
功能测试 :active, a1, after des3, 3d
压力测试 :after a1 , 20h
测试报告 : 48h
参考:菜鸟教程