有关 Markdown 的概念性问题,请点击链接自行查看。本文旨在整理一些平时写文档时常用的一些语法,这样既方便他人查看,也以免自己忘记。
标题
Markdown 支持两种形式的标题,Setext 和 atx,常用的是 atx 语法的标题,本文以此为主。
Atx 样式的标题每行开头使用 1-6 个井号,井号的个数对应 1-6 级标题(最多也就 6 级),例如:1
2
3
4
5# 一级标题
## 二级标题
#### 四级标题
效果如下:
块引用
块引用的方式很简单,例如:1
> xxxx
效果如下:
xxxx
引用内还可以包含 Markdown 的其他元素,如列表和代码块等,这里不详细介绍了。
列表
Markdown 支持有序列表和无序列表。
无序列表
无序列表使用星号、加号和连字符,使用任一符号都可以实现一样的效果,例如:1
2
3
4
5
6
7
8
9
10
11* peach
* apple
* banana
+ peach
+ apple
+ banana
- peach
- apple
- banana
效果如下:
- peach
- apple
- banana
- peach
- apple
- banana
- peach
- apple
- banana
有序列表
有序列表使用数字加点完成(点后与字符之间有空格),例如:1
2
31. peach
2. apple
3. banana
效果如下:
- peach
- apple
- banana
列表之间还可以进行嵌套使用,形成一级表头和二级表头这样的东西,如:1
2
3
4
5- xxx
- xxx
1. 111
2. 222
效果如下:
- xxx
- xxx
- 111
- 222
代码块
常见用法主要有单行代码块和多行代码块。
单行代码块
单行代码块使用一对重音符``来书写,直接将代码放到重音符中间即可,如:1
`xxx`
xxxxxx
xxx
多行代码块
多行代码块使用三对重音符来书写,同样将代码块放到中间即可,如:1
2
3
4
5(```)
xxxbbbxxx
(```)
注意实际是没有括号的
效果如下:1
xxxbbbxxx
水平线
如果一行中只有三个以上的连字符、星号或下划线,则会在该位置生成一个<hr>
标签,这条线可以叫水平线,也可以叫分割线,效果如下:
不同的 Markdown 编辑器渲染出来的效果可能不一样。
表格
Markdown 内表格的用法有点麻烦,需要使用冒号、竖线和连字符来完成,如:1
2
3
4表头 | 表头 | 表头
-- | :--: | --:
1 | 2 | 3
4 | 5 | 6
效果如下:
表头 | 表头 | 表头 |
---|---|---|
1 | 2 | 3 |
4 | 5 | 6 |
大致说明一下:
第二行是格式控制行,-
有一个就可以了,有时为了对齐会多加几个;除了第二行外的其他行中的文字是默认居左的,两边都加:
,就可以居中,右边加:
就可以居右。
表格中的文字也能使用 Markdown 中文字相关的语法;如果想要改变表格中文字的颜色,可以借助font
标签来完成。
文字
与文字相关的语法,如:1
2
3
4**加粗**
*斜体*
***斜体加粗***
~~删除~~
效果如下:
加粗
斜体
斜体加粗删除
图片引用
基本语法,如:1
2
3![图片名称](图片地址 "图片下标题")
如:
![zzz](https://timgsa.baidu.com/timg?image&quality=80&size=b9999_10000&sec=1600276810120&di=ffb59bf5363570267ac8201139b33c94&imgtype=0&src=http%3A%2F%2Fa2.att.hudong.com%2F86%2F10%2F01300000184180121920108394217.jpg "xxx")
效果如下:
链接
基本语法,如:1
2
3[链接名称](链接地址)
如:
[Baidu](https://www.baidu.com)
效果如下:
Baidu