Mark down 语法

插入目录[TOC]

目录

• 插入目录[TOC]
  • 1. Markdown 标题
    • 1.1 =-
• 我展示的是一级标题
  • 我展示的是二级标题
    • 1.2 #
• 一级标题
  • 二级标题
    • 三级标题
      • 四级标题
        • 五级标题
          • 六级标题
  • 2. Markdown 段落
    • 2.1 段落换行(结尾处加两个以上空格并回车)
    • 2.2 段落换行(直接用空白行隔开)
  • 3. 字体(斜体*、_，粗体**、__，粗斜体***、___)
  • 4. 分隔线(单独行用三个以上的*或-，可以有空格)
  • 5. 删除线(文字两端加两个~)
  • 6. 下划线(<u>文本</u>)
  • 7. 脚注([^要注明的文本])
  • 8. Markdown列表
    • 8.1 无序列表(*、+、-)
    • 8.2 有序列表(数字加点\1.)
    • 8.3 列表嵌套(在子列表前面加两个或四个空格)
  • 9. Markdown区块
    • 9.1 普通区块(段落前加>后面紧跟一个空格)
    • 9.2 区块嵌套(第一层> 、第二层> >)
    • 9.3 区块中使用列表
    • 9.4 列表中使用区块
  • 10. Markdown 代码
    • 10.1 代码片段(用`包起来)
    • 10.2 代码区块(使用4个空格或制表符)
    • 10.3 代码区块(使用```包起来，也可指定一种语言)
  • 11. Markdown 链接
    • 11.1 普通链接
    • 11.2 高级链接
  • 12. Markdown 图片
    • 12.1 普通嵌入
    • 12.2 高级嵌入
    • 12.3 使用<img>可以指定宽度
    • 13.2 不设置对齐方式
  • 14. Markdown高级技巧

1. Markdown 标题

1.1 =-

我展示的是一级标题
=

我展示的是二级标题
-

↓

我展示的是一级标题

我展示的是二级标题

1.2 #

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

↓

一级标题

二级标题

三级标题

四级标题

五级标题

六级标题

2. Markdown 段落

2.1 段落换行(结尾处加两个以上空格并回车)

段落1  (加两个空格并回车)
段落2  (加两个空格并回车)
段落3  (加两个空格并回车)

↓

段落1
段落2
段落3

2.2 段落换行(直接用空白行隔开)

段落1 
(加入空白行) 
段落2  
(加入空白行) 
段落3
(加入空白行) 

↓

段落1

段落2

段落3

3. 字体(斜体*、_，粗体**、__，粗斜体***、___)

*斜体文本*
_斜体文本_
**粗体文本**
__粗体文本__
***粗斜体文本***
___粗斜体文本___

↓

斜体文本
斜体文本
粗体文本
粗体文本
粗斜体文本
粗斜体文本

4. 分隔线(单独行用三个以上的*或-，可以有空格)

***

* * *

*****

- - -

----------

↓

---

---

---

---

---

5. 删除线(文字两端加两个~)

~~BAIDU.COM~~

↓

BAIDU.COM

6. 下划线(<u>文本</u>)

<u>带下划线文本</u>

↓

带下划线文本

7. 脚注([^要注明的文本])

百度地址[^Baidu]
[^Baidu]:www.baidu.com

↓

百度地址^[1]

8. Markdown列表

8.1 无序列表(*、+、-)

* 第一项
* 第二项
* 第三项

+ 第一项
+ 第二项
+ 第三项


- 第一项
- 第二项
- 第三项

↓

• 第一项
• 第二项
• 第三项

• 第一项
• 第二项
• 第三项

• 第一项
• 第二项
• 第三项

8.2 有序列表(数字加点\1.)

1. 第一项
2. 第二项
3. 第三项

↓

1. 第一项
2. 第二项
3. 第三项

8.3 列表嵌套(在子列表前面加两个或四个空格)

1. 第一项：
    - 第一项嵌套的第一个元素
    - 第一项嵌套的第二个元素
2. 第二项：
    - 第二项嵌套的第一个元素
    - 第二项嵌套的第二个元素

↓

1. 第一项：
   • 第一项嵌套的第一个元素
   • 第一项嵌套的第二个元素
2. 第二项：
   • 第二项嵌套的第一个元素
   • 第二项嵌套的第二个元素

9. Markdown区块

9.1 普通区块(段落前加>后面紧跟一个空格)

> 区块引用
> 菜鸟教程
> 学的不仅是技术更是梦想

↓

区块引用
菜鸟教程
学的不仅是技术更是梦想

9.2 区块嵌套(第一层> 、第二层> >)

> 最外层  
> > 第一层嵌套  
> > > 第二层嵌套  

↓

最外层

第一层嵌套

第二层嵌套

9.3 区块中使用列表

> 区块中使用列表
> 1. 第一项
> 2. 第二项
> + 第一项
> + 第二项
> + 第三项

↓

区块中使用列表

1. 第一项
2. 第二项

• 第一项
• 第二项
• 第三项

9.4 列表中使用区块

* 第一项
    > 菜鸟教程
    > 学的不仅是技术更是梦想
* 第二项

↓

• 第一项

  菜鸟教程
  学的不仅是技术更是梦想

• 第二项

10. Markdown 代码

10.1 代码片段(用`包起来)

`printf()`函数

↓

printf()函数

10.2 代码区块(使用4个空格或制表符)

     javascript
$(document).ready(function () {
    alert('RUNOOB');
});

↓

javascript
$(document).ready(function () {
alert('RUNOOB');
});

10.3 代码区块(使用```包起来，也可指定一种语言)

    javascript
$(document).ready(function () {
    alert('RUNOOB');
});

11. Markdown 链接

11.1 普通链接

[链接名称](链接地址)

或者

<链接地址>

这是一个链接 [菜鸟教程](https://www.runoob.com)
<https://www.runoob.com>

↓

这是一个链接 菜鸟教程
https://www.runoob.com

11.2 高级链接

这个链接用 1 作为网址变量 [Google][1]
这个链接用 runoob 作为网址变量 [Runoob][runoob]
然后在文档的结尾为变量赋值（网址）

  [1]: http://www.google.com/
  [runoob]: http://www.runoob.com/

↓

这个链接用 1 作为网址变量 Google
这个链接用 runoob 作为网址变量 Runoob
然后在文档的结尾为变量赋值（网址）

12. Markdown 图片

12.1 普通嵌入

![alt 属性文本](图片地址)

![alt 属性文本](图片地址 "可选标题")

↓

12.2 高级嵌入

这个链接用 1 作为网址变量 [RUNOOB][1].
然后在文档的结尾为变量赋值（网址）

[1]: http://static.runoob.com/images/runoob-logo.png

↓

这个链接用 1 作为网址变量 RUNOOB.
然后在文档的结尾为变量赋值（网址）

12.3 使用<img>可以指定宽度

<img decoding="async" src="http://static.runoob.com/images/runoob-logo.png" width="50%">

↓

## 13. Markdown 表格 ### 13.1 设置对齐方式 ```c | 表头 | 表头 | | ---- | ---- | | 单元格 | 单元格 | | 单元格 | 单元格 | ``` **↓**

表头	表头
单元格	单元格
单元格	单元格

13.2 不设置对齐方式

| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |

↓

左对齐	右对齐	居中对齐
单元格	单元格	单元格
单元格	单元格	单元格

14. Markdown高级技巧

目前支持的 HTML 元素有：<kbd><b> <i><em> <sup> <sub> <br>等

转义
使用\帮助插入普通字符

画图
画流程图、时序图(顺序图)、甘特图

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、标准流程图源码格式：

```flow
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、标准流程图源码格式（横向）：

```flow
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时序图源码样例：

```sequence
对象A->对象B: 对象B你好吗?（请求）
Note right of 对象B: 对象B的描述
Note left of 对象A: 对象A的描述(提示)
对象B-->对象A: 我很好(响应)
对象A->对象B: 你真的好吗？
```
6、UML时序图源码复杂样例：

```sequence
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 王五: 合理 食物
看医生...
李四-->>张三: 很好!
王五->李四: 你怎么样?
李四-->王五: 很好!
```
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
```

效果图

---

1. www.baidu.com ↩︎