《了不起的Markdown》之第2章 人人都能学会Markdown

2.1 基础语法

2.1.1 字体

1. 标题

语法：

//底线（-/=）方式标题只支持两级
一级标题，=可多个
=

二级标题，-可多个
-

//#方式支持六级标题
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

推荐结构：

# 文档标题（建议与文件名相同，尽量简短）

作者（可选，声明文档作者；开源项目文档，作者写在修订历史中）

摘要（1~3句话描述文档核心内容）

目录（快速了解文档结构，便于导航）

正文（正文标题从二级目录开始，逐级增加，不可跳级，不可相同）

## 标题1（建议标题前后空一行）

### 标题1.1

## 标题2

### 标题2.1

### 标题2.2

2. 粗体和斜体

语法：

**加粗内容**（推荐）
或
__加粗内容__

*斜体内容*（推荐）
或
_斜体内容_

效果：

加粗内容
或
加粗内容

斜体内容
或
斜体内容

2.1.2 段落与换行

段落由一行或多行文本组成，不同段落间使用空行来标记，段内换行需要两个以上空格加回车。

1. 列表

有序列表

语法：

1.【空格】第一
2.【空格】 第二
3.【空格】 第三

效果：

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

无序列表

语法：

*【空格】选项
+【空格】选项
-【空格】选项

效果

• 选项

• 选项

• 选项

嵌套列表
列表可以嵌套列表，有序列表和无序列表可以互相嵌套。
语法：

+【空格】第一层列表
【TAB】+【空格】第二层列表
【TAB】【TAB】+【空格】 第三层列表

效果：

• 第一层列表
  • 第二层列表
    • 第三层列表

2. 分隔线

语法：

***
或
---
或
___

效果：

---

或

---

或

---

2.1.3 图片

语法：

![图片替代文字，图片不正常时显示，可为空](本地或网络图片地址，相对或绝对路径)

2.1.4 链接

1. 文字链接：

[链接文字](链接地址)

百度

2. 引用链接：

[链接文字[链接标记]
或者
[链接标记]

[链接标记]: 链接地址
链接标记，类似变量，可放在任意位置（一般放页尾）

参考链接1

参考链接1

3. 网址链接：

<网址>
或
<邮箱>

http://www.baidu.com
[email protected]

2.1.5 行内代码与代码块

1. 行内代码

`代码`

代码

2. 代码块

TAB开头：
	def test_print():
		pass
或
4个空格开头：
    def test_print():
    	pass

def test_print():
	pass

或

def test_print():
	pass

2.1.6 引用

> 引用内容

> 引用1
>> 嵌套引用

引用1

嵌套引用

2.1.7 转义

\特殊符号

\ ` * _ {} [] () # + - . !

2.2 扩展语法GFM

GitHub Flavored Markdown

2.2.1 删除线

~~被删除文字~~
被删除文字

2.2.2 表情符号

:表情代码:	表情符号
:smile:
:laughing:
:+1:
:-1:
:clap:

表情符号参考

2.2.3 自动链接

<网址>
http://www.baidu.com

2.2.4 表格

|1|2|3|
|:--|:-:|--:|
|左|中（默认）|右|

1	2	3
左	中（默认）	右

2.2.5 任务列表

- [ ] 未勾选
- [x] 已勾选

• 未勾选
• 已勾选

2.2.6 围栏代码块

// A code block
var foo = 'bar';

// An highlighted block
var foo = 'bar';

2.2.7 锚点

锚点（书签），标记文档特定位置，用于跳转。

[锚点描述](#锚点名)
或
锚点名

锚点定义：
锚点名

锚点1
锚点1

锚点2
锚点2

2.3 排版技巧

2.3.3 关于空格

英文标点符号（,.;:?等）与后面字符间需要加空格，与前面字符间不需要加空格

中英文中使用 > (半角)，前后都加空格
Settings > General > Reset
设置 > 通用 > 还原

中文标点符号和数字、中文、英文间不加空格
MacBook Pro（15英寸，2016年年末）

数字和百分号间不加空格
15%

数字和单位符号间不加空格
3.1GB/s，2TB

英文与数字组合名字间不加空格
Intel Core i7、iPhone 6s Plus、A9、3D Touch

/（半角）表示或、路径时，前后都不加空格
/root/data/test.txt
Python/Java/Go/C

货币符号后不加空格
$149

负号后不加空格
3 - 5 = -2

2.3.4 全角和半角

中文标点符号（，。；：！#）是全角，两个字节，用于中文
英文标点符号和数字(,.;:!#0-9)是半角，一个字节，用于英文

2.3.5 正确的英文大小写

iPhone 7、macOS、iPad Pro、Macbook Pro、iOS、GitHub