Markdown语法

Markdown是什么

markdown是一种轻量级标记语言,它以纯文本形式编写文档,并最终以HTML格式发布。它由Aaron Swartz和John Gruber共同设计。

语法

标题

标题使用=和-标记一级和二级标题。也可以使用#标记1-6级标题。常用#来标记
示例

1
2
3
4
5
6
# 一级标题 
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

段落

段落的前后要有空行(使用空白行将一行或多行文本进行分隔),若想在段内强制换行是使用两个以上空格加上回车
注意:除非段落在列表中,否则不要用空格或制表符缩进段落

换行

在一行的末尾添加两个或多个空格,然后回车,即可创建一个换行。除此之外还可以在结尾用HTML的<br>标签来进行换行

强调

粗体

在需要加粗的单词或短语的前后各添加两个星号或者下划线。
示例

1
这是**加粗**例子

斜体

在需要斜体表示的单词或短语的前后添加一个星号或下划线。
示例

1
这是*斜体*示例

粗体和斜体

要同时用粗体和斜体突出文本,在单词或短语的前后各添加三个星号或下划线。
示例

1
这是 ***粗体和斜体*** 示例

注意:同时粗体和斜体表示时,三个星号前面需要有空格这样否则只能识别其中两个星号

块引用

要创建块引用,在段落前加一个>符号

多个段落的块引用

多个段落的块引用,只需要为段落之间的空白行添加一个>符号

嵌套块引用

在要嵌套的段落前添加一个>>符号

示例

1
2
>这是块引用
>>这是嵌套引用

列表

有序列表

在每个列表项前添加数字并紧跟一个英文点(.),数字不必按数学顺序排列,但是列表应当以数字1开始

无序列表

在每个列表项前面添加破折号(-)、星号(*)或者加号(+),缩进一个或多个列表项可以创建嵌套列表
示例

1
2
3
4
5
1. 这是有序列表
2. 这是有序列表

* 这是无序列表
* 这是无须列表

代码

讲单词或短语包裹在反引号(`)中,如果要表示的代码的单词或短语中包含一个或多个反引号,可以将单词或短语包裹在双反引号中(``)

代码块

将代码块的每一行用三个反引号包裹代码块。
示例:

1
2
3
void main(){
print("hello world")
}

分割线

在单独一行上使用三个或多个星号(***)、破折号(—)或下划线(___)并且不能包含其他内容

超链接

将链接文本包括在方括号中,后面紧跟着括在圆括号中URL。还可以选择为链接添加标题,当用户鼠标悬停在链接上时就会显示一个提示,把标题放在url后面
示例

1
这是[google](https://www.google.com "点击打开google")

要将URL或电子邮件地址快速转换为链接,只需要将其括在尖括号中
示例

1
2
<https://www.google.com>
<34523423@qq.com>

图片

要添加图片,首先添加感叹号!紧跟着方括号,方括号中可添加替代文本,即图片显示失败之后显示此文本,最后跟着圆括号,圆括号中添加图片资源的路径或URL
示例

1
![这是图片描述文本](图片路径 图片标题)

注意:图片路径也可以用图片base64文本,然后用引用式链接的方式引用图片
示例

1
2
![图片文本][引用图片名]
[引用图片名]:data:image/png;base64,图片base64文本

表格

制作表格使用|来分隔不同的单元格,使用-来分隔表头和其他行
示例

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

设置对齐方式

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