目录
1.了解Markdown
2.Markdown的基础语法
3.扩展语法GFM
4.排版技巧
了解Markdown
- 作者: John Gruber
- 使用场景:对文章的排版没什么特殊的需求时,建议使用Markdown,如果对文章的排版要求很高,建议使用Word文档
- 支持内部嵌套HTML
Markdown的基础语法
标题
使用底线的语法如下
一级标题
=======
二级标题
-------
语法说明如下
(1)底线“=”表示一级标题
(2)底线“-”表示二级标题
(3)底线符号的数量至少两个
(4)这种语法只支持一级和二级标题
使用“#”的语法如下
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
语法说明如下
(1)公式:# + 空格 + 标题内容
(2)“#”的个数表示个标题的等级
(3)Markdown中最多只支持前六级标题
使用建议
(1)建议使用“#”标记标题,易于阅读和维护
(2)除标题在文档开头外,建议标题的前后都要空一行,否则可能会导致阅读困难
粗体和斜体
粗体的语法格式如下
**加粗内容**
or
__加粗内容__
斜体的语法格式如下
*斜体内容*
or
_斜体内容_
使用建议
(1)建议粗体用两个 * 包裹,斜体用 * 包裹,这样易于维护和阅读
列表
有序列表的语法如下
语法公式:数字序号 + 英文句号 + 空格 + 列表内容
1. 列表1
2. 列表2
3. 列表3
4. 列表4
5. 列表5
无序列表的语法如下
*/+/- + 空格 + 列表内容(使用“ */+/- ”的效果是一样的)
嵌套列表的语法如下
第一层列表
Tab + 第二层列表
Tab + Tab + 第三层列表
Tab + Tab + Tab + 第四层列表
Tab + Tab + Tab + Tab + 第五层列表
PS:有序列表和无序列表可以互相嵌套
使用建议
(1)建议使用“-”来标记无序列表,因为“*”容易和粗体和斜体混淆,“+”不太流行
分割线
分割线的语法如下:
在Markdown中,分割线由三个或三个以上的*/-/_来标记(建议用*或-)
图片
Markdown插入图片的语法如下
插入图片的语法: ![文字](图片地址)
PS:(1)图片地址支持相对路径、绝对路径和网络图片地址
(2)若是图片无法显示,则显示该中括号内的文字内容
链接
文字链接的语法如下
[链接文字](链接地址)
引用链接的语法如下
在正文中引用链接标记,可以理解为引用定义好的变量
[链接文字](链接标记)
在底部定义链接标记,可以理解为定义一个地址变量
[链接标记]:(链接地址)
PS:链接标记不区分大小写,且链接标记可以有字母、数字、空格和标点符号
使用建议
(1)定义的链接内容可以放在当前文件的任意位置,建议放在页尾
网址链接的语法如下
<网址链接>
行内代码和代码块
行内代码的语法如下
在Markdown中,行内代码应用使用`包裹,语法为:`代码`
代码块的语法如下
在Markdown中,代码块以Tab键或4个空格开头
如果代码很多行,可以使用围栏代码块(扩展语法),并声明是什么语言,这样做便于阅读,并且可以显示语法高亮
```编程语言
代码块
```
引用
引用语法如下:
> 引用内容
引用说明
- 多行引用也可在每一行的开头都> 插入“>”
- 在引用中可以嵌套引用
- 在引用中可以使用其他的Markdown语法
使用规范
- 在引用的标记符号“>”后面添加一个空格
- 建议每一行的引用都是用符号“>"
- 不要在引用中添加空行,如果要空行,要添加标记符号“>”
转义
当我们想在Markdown文件中插入一些标记符号,但又不想让这些符号被渲染时,可以使用“\”进行转义,语法如下
\特殊符号
可以被转义的特殊符号如下:
\ 反斜线
` 反引号
* 星号
_ 底线
{} 大括号
[] 中括号
() 小括号
# 井字号
+ 加号
- 减号
. 英文句号
! 感叹号
> 大于号
扩展语法GFM
删除线
删除线的语法如下
~~被划上删除线的文字~~
表情符号
表情符号的语法如下
:表情代码:
PS:表情符号的代码请参考http://www.webpagefx.com/tools/emoji-cheat-sheet
网页跳转链接
在标准语法中,由<>包裹的网址被自动识别并解析位超链接,使用扩展语法则可以不适用<>包裹
注意:网页跳转链接只识别以www或http://开头的URL地址
如果不想使用自动连接,也可以使用`来包裹网址,语法如下
`网址`
表格
表格的语法如下
| 表头1 | 表头2 | 表头3 |
| ---- | ----- | ----- |
| 内容1 | 内容2 | 内容3 |
| 内容4 | 内容5 | 内容6 |
表格的对齐格式语法如下
- 左对齐(默认)::----
- 右对齐:----:
- 居中对齐::----:
注意事项
- 单元格使用“|”来分割,为了阅读更清晰,建议最前和最后都使用“|”
- 表头和其他行使用----来分割
- 块级元素(代码区块、引用区块)不可插入表格中
- 建议不要使用庞大而复杂的表格,那样会难以维护和阅读
任务列表
任务列表的语法如下
- [] 未勾选
- [x] 已勾选
PS:“x”用小写的x,因为有些编辑器可能不支持大写
围栏代码块
围栏代码块语法如下
```编程语言的名字
代码块
```~~~编程语言的名字
代码块
~~~
语法说明如下
围栏代码块使用连续3个“`”或连续三个“~”包裹,支持语法高亮并可以加上编程语言的名字
锚点
锚点也成为书签,用来标记文档的特定位置,使用锚点可以跳转到当前文档或其它文档中制定的标记位置
锚点的语法如下
[锚点描述](#锚点名)
注意事项
- 锚点名建议使用字母和数字,当然中文也是被支持的,但不排除有些网站支持的不够好
- 锚点名是区分英文大小写的
- 在锚点名中不能含有空格,也不可以含有特殊字符
排版技巧
关于空格
一些需要添加空格的情况
- 英文标点符号(如,.;:?等)后面的字符要添加空格
- 当在中英文中使用半角符号时,两边都要添加空格(如 + , -, *, <> , = 等)
不需要添加空格的情况
- 中文标点符号和数字、中文、英文之间不需要添加空格
- 数字和百分号之间不需要添加空格
- 数字和单位符号之间不需要添加空格
- 英文和数字组合成的名词之间不需要添加空格
- 当/(半角)bcui “或”、“路径”时,前后都不需要添加空格
- 货币符号后不添加空
- 负号后面不添加空格
半角和全角
- 在中文排版中,要使用全角标点符号
- 在英文排版中,要使用半角标点符号
正确的英文大小写
很多人在文章、邮件甚至简历中,会把专有名词写错,虽然这并不会影响人们对内容的理解,但有时候的确会让人觉得你不太“专业”,所以专有名词要使用正确的大小写。