背景

一直用MD写文档和资料，偶尔还会忘记一些语法，因此，写一篇文档作为记录

markdown文件一般文件类型为.md，它是一种常用编写语法,是一种快速标记、快速排版语言。现在很多前端项目中的说明文件readme等都是用.md文件编写的，而且很多企业也在在鼓励使用这种编辑方式，比如github的readme就是md格式。md格式非常适合编程人员使用。

基本符号

md格式的基本关键符号是 * - + # >

基本上所有的markdown标记都是基于这几个符号或组合，需要注意的是，如果以基本符号开头的标记，注意基本符号后有一个用于分割标记符和内容的空格。

标题

主副标题

主副标题用在文件开头

主标题语法：主标题文字空行 ==（两个及以上）

示例：

1
2
3


主标题

===

副标题语法：副标题文字空行 —（两个及以上）

大纲标题

标题使用(#+空格)开头，以#个数表示层级，1-6个#分别表示H1-H6

语法#+空格标题空格+# 也是可以的，但比较少用。

示例：

1
2
3
4
5
6


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

注意：大纲最多6级

段落和格式

段落

Markdown 段落没有特殊的格式，直接编写文字。

段落换行：使用两个以上空格加上回车
新段落：后面使用一个空行来表示重新开始一个段落。

字体

Markdown可以使用3种字体格式，注意：*和_中间不要有空格

1
2
3
4
5
6


*斜体*
_斜体_
**粗体**
__粗体__
***粗斜体***
___粗斜体___

效果如下
斜体斜体粗体粗体 粗斜体 粗斜体

分隔符

一行中用三个以上的星号、减号、底线建立一个分隔线，行内不能有其他内容。在星号或是减号中间插入空格（不推荐）。

示例：

1
2
3


***
---
___

效果如下：

删除线

文字两端加上两个波浪线 ~~

示例

1

~~删除线~~

效果：

~~删除线~~

下划线

通过HTML的标签对来实现

示例

1

<u>下划线</u>

效果：

下划线

脚注

脚注是对文本的补充说明，类似于学位论文中的参考文献定义和引用。使用方法：

在需要脚注的地方用[ ^脚注1]，注意[和^之间无空格

然后在文档的其他地方定义，注意一定要另起一行

示例

1
2
3


引用的地方[^引用1]

[^引用1]:xxx文献

效果

引用的地方¹

列表

无序列表

无序列表使用星号()、加号(+)、减号(-)作为列表标记，列表标记符后面一定要加一个空格*

示例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


* 无序列表1
* 无序列表2
* 无序列表3
* 无序列表4

+ 无序列表5
+ 无序列表6
+ 无序列表7

- 无序列表8
- 无序列表9

对应的效果如下:

无序列表1
无序列表2
无序列表3
无序列表4

无序列表5
无序列表6
无序列表7

无序列表8
无序列表9

有序列表

有序列表使用数字并加上 . 号，并用空格隔开后面的内容。注意是英文状态下的**.**

示例

1
2
3


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

效果

第一项
第二项
第三项

列表间可以相互嵌套

区块

区块引用是在段落开头使用 > 符号，然后后面紧跟一个空格符号。

示例

1
2
3


> 示例1
> 示例2
> 示例3

效果

示例1 示例2 示例3

区块可以嵌套的，使用 > 个数作为层数，一个 > 符号是第一层，两个 > 符号是第二层，以此类推。注意：每一个>后面都要跟空格。

示例

1
2
3
4


> 第一层
> > 第二层
> > > 第三层
> > > > 第四层

效果

第一层

第二层

第三层

第四层

另外，区块还可以和列表配合使用。

代码

代码用3个反引号(`)把它包起来。第一组反引号后面可以写对应的语言，也可以不写。

示例

1
2
3
4


​```c
int a = 0;
a++;
​```

效果

1
2


int a = 0;
a++;

代码区块同时也可以使用 4 个空格或者一个制表符（Tab 键)

超级链接

2种使用方法：

1
2


1. [链接名称](链接地址)
2. <链接地址>

要点：1.使用方括号[]和括号()，两者之间没有空格。2.直接用尖括号<>，里面写链接地址即可。

示例

1
2


[luck78](https://luck78.com)
<https://luck78.com>

效果

luck78 https://luck78.com

图片

使用方法和超级链接的第一种方式很像，就是在前面再多加一个!

语法:

1

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

图片地址可以是相对路径、绝对路径、网址链接。

表格

表格使用 | 来分隔不同的单元格（列），使用 - 来分隔表头和内容行，-数量没有具体限制，但最好保持一致。每一行代表表格上的行。

语法格式:

1
2
3
4


|  表头   | 表头  |
|  ----  | ----  |
| 单元格1  | 单元格2 |
| 单元格3  | 单元格4 |

效果

表头	表头
单元格1	单元格2
单元格3	单元格4

表格对齐方式通过-设置，格式如下：

-: 设置内容和标题栏居右对齐。 :- 设置内容和标题栏居左对齐。 :-: 设置内容和标题栏居中对齐。

示例

1
2
3
4


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

效果

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

其他

HTML元素

markdown目前支持的部分HTML 元素，有：<kbd>  。使用方法和HTML一致。

转义

同一般的转义方式一致，使用反斜杠\加markdown的关键字。

公式

数学公式使用两个美元符 $$ 包裹 TeX 或 LaTeX 格式的数学公式来实现。数学公式渲染需要 Mathjax 支持。

流程图

流程图、甘特图、UML等使用方法和代码一致，只需要指定具体的格式，然后输入流程图代码即可。

参考资料

https://www.jianshu.com/p/399e5a3c7cc5
https://www.runoob.com/markdown/md-paragraph.html

xxx参考文献 ↩︎

MarkDown(MD)格式参考学习

文章目录

背景