MarkDown 基本语法
MarkDown 是一种纯文本格式的标记语言,通过简单的标记语法,可以使普通的文本具有一定的格式。它是将文档以 HTML 格式发布,最终的显示效果取决于前端的渲染。MarkDown 也可以理解为将以 MarkDown 语法编写的纯文本转换成 HTML 的工具,最终在网页显示 HTML 内容。
目录
一、标题
使用 #
表示 1~6 级标题
标准语法是在 #
后跟一个空格,1 个 #
表示一级标题,2 个 ##
表示二级标题
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
效果如下:
一级标题
二级标题
三级标题
四级标题
五级标题
六级标题
一级标题和二级标题还可以通过 ===
和 ---
符号标记,标记方式如下:
一级标题
===
二级标题
---
效果如下:
一级标题
二级标题
二、目录
目录使用 [显示文字](#段落中的标题)
的形式链接到当前文档的特定位置,如下写法可连接到本文档的 九、列表
位置处,写法如下
[链接到第九章](#九、列表)
效果如下
链接到第九章
三、段落
需要使用空行分段,即段落的前后需要是空行,只回车换行在显示效果中是没有换行效果的。
若想在一个段落内换行,需要在行尾加上至少两个空格,再回车换行。
若想在特定位置加入空行,可以在使用 <br>
表示空行,如下所示:
直接回车换行
不能实现换行功能
行末加两个空格
实现换行
使用<br>表示换行<br><br>换两行
效果如下:
直接回车换行
不能实现换行功能
行末加两个空格
实现换行
使用
表示换行
换两行
四、字体
-
粗体
使用**粗体文字**
的形式,在要加粗的文字两端使用两个**
包裹起来粗体文字
-
斜体
使用*斜体文字*
的形式,在文字的两端使用*
包裹起来斜体文字
-
删除线
使用~~删除线文字~~
的形式,在文字的两端使用~~
包裹起来删除线文字
以上方式还可以组合使用,如下所示
***加粗的斜体文字***
~~*斜体带删除线文字*~~
~~**加粗带删除线文字**~~
~~***加粗的斜体带删除线文字***~~
效果如下
加粗的斜体文字
斜体带删除线文字
加粗带删除线文字
加粗的斜体带删除线文字
五、引用
引用在行首加 >
符号即可,还可嵌套引用,输入多个 >
即可,如下所示
> 引用
>> 嵌套引用
>>> 多层嵌套引用
效果如下
引用
嵌套引用
多层嵌套引用
六、分割线
分割线使用三个或三个以上的 -
或 *
符号
---
***
效果如下
注意,在使用 ---
符号时,上一行应当是空行,否则其会将上一行解释为二级标题,而不是分割线
七、超链接
超链接使用 [超链接名](超链接地址 "超链接标题")
的语法,其中 "超链接标题" 可写可不写,其效果为鼠标悬停时显示的文字
[百度](https://www.baidu.com "百度网址")
效果为
百度
八、图片
插入图片的语法和插入超链接类似,只需在链接前面加上 !
即可,语法如下
![图片alt](图片地址 "图片title")
其中图片地址可以是本地路径,也可以是网络图片
九、列表
-
无序列表
使用+
、-
、或*
标记无需列表,如下写法+ 第一项
- 第二项
* 第三项
效果如下
- 第一项
- 第二项
- 第三项
还可以通过写 <li>
的形式标记列表项,如下写法
<li> 项一
<li> 项二
效果为(部分解释器可能不支持)
<li> 项一
<li> 项二
-
有序列表
使用数字.
来表示,一般列表的第一个数字为起始编号数字,后面会自动加一排序,如下写法1. 有序第一行
2. 有序第二行
3. 有序第三行
2. 有序第一行
8. 有序第二行
1. 有序第三行
效果如下
- 有序第一行
- 有序第二行
- 有序第三行
- 有序第一行
- 有序第二行
- 有序第三行
还可以通过写 <ol start="1"><li>……<li>
的形式写有序列表,如下写法(部分解释器可能不支持):
<ol><li> 有序项一
<li> 有序项二
<ol start="5"><li> 有序项一
<li> 有序项二
效果为:
<ol><li> 有序项一
<li> 有序项二
<ol start="5"><li> 有序项一
<li> 有序项二
注意:在列表中,若想实现缩进,即一个列表项下想把较多的内容都缩进到列表项后面,需要在换行后的内容的行首加3个空格
列表嵌套
列表嵌套需要在下一级列表前输入3个空格,如下写法(此处用 s 表示空格)
1. 一级有序列表
sss* 二级无需列表
效果如下
- 一级有序列表
- 二级无需列表
十、表格
表格语法如下
|表头1|表头2|表头3|
|:---|:---:|----:|
|内容|内容|内容|
|a|b|c|
显示效果如下
表头1 表头2 表头3 内容 内容 内容 a b c
其中,最前面一列和最后一列的 |
可以省略不写,第二行中的 :
指示此列的对齐方式,写在左面为左对齐,写在右面为右对齐,写在两端为居中
表格中写列表时,可以采用第九章中描述的 <li>
或 <ol><li>
标记的形式实现,如下写法:
|表头1|表头2|表头3|
|:---|:---:|----|
|内容|内容|内容描述,下面是列表<br><li> 选项一 <li> 选项二|
|a|b|比较长的内容,下面是有序列表<br><ol start="1"><li> 有序选项一 <li> 有序选项二|
显示效果为(部分解释器可能不支持):
表头1 | 表头2 | 表头3 |
---|---|---|
内容 | 内容 | 内容描述,下面是列表 <li> 选项一 <li> 选项二 |
a | b | 比较长的内容,下面是有序列表 <ol start="1"><li> 有序选项一 <li> 有序选项二 |
十一、其它符号
转义符号
\
转义符号\
用于输出特殊符号-
代码标识符号 '`'
代码标识符号 ' ` ' 用于标记代码,行内使用时,使用 `代码` 完成行内标记,如:代码
当不使用行内代码,而是标记代码段时,在代码段的前后用 ``` 包裹起来,如:```
int add(int a, int b)
{
return a + b;
}
```效果为
int add(int a, int b) { return a + b; }
可以手动指定代码的语言类型,语法为在第一个 '```' 后写上语言名称,如上所示代码写成下面的形式:
```cpp
int add(int a, int b)
{
return a + b;
}
```效果为:
int add(int a, int b) { return a + b; }
-
数学公式转义符号
$
数学公式转义符号用于转义数学公式,当使用行内公式时,使用一个
$
符号 包裹公式,使用单独一行的公式时,使用$$
包裹公式,如下:行内公式:$f(x)=ax+b$
$$E=mc^2$$
效果为:
行内公式:
关于数学公式的具体用法请参见:
雷震西山 2019年10月20日