目录

• 标题
• 换行与段落
• 引用
• 代码块
• 强调
• 列表
• 分割线
• 超链接
• 图片
• 表格
• 符号和特殊字符
• 锚点
• 流程图

一. 标题

在想要设置标题的文字前面加#号来表示，支持范围从1-6
注：需要在#后面添加空格或制表符
示例：

# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题

效果如下：

一级标题

二级标题

三级标题

四级标题

五级标题

六级标题

二. 换行与段落

换行

markdown想要实现换行，需要在每一行的后面输入两个或两个以上的空格加回车（某些编辑器下单回车也可实现换行），或者使用html的<br>标签
示例：

行一  
行二  
行三

效果如下：
行一
行二
行三

段落

markdown的段落只要在上一段落和下一段落之间存在空行，就可渲染段落效果，空行可以输入回车和空格
示例：

段落一  

段落二

段落三

效果如下：
段落一

段落二

段落三

注：如果想要实现段落的首行缩进，可以通过如下的方式

半方大的空白 或 
全方大的空白 或 
不断行的空白格 或 

三. 引用

在引用的内容前加>即可。引用可嵌套，即多个>。 示例：

>引用内容
>>引用嵌套内容
>>>引用嵌套内容

效果如下：

引用内容

引用嵌套内容

引用嵌套内容

四. 代码块

语法：

• 单行代码：代码之间用一个`包起来

  `代码内容`
  

• 代码块：代码之间用三个`包起来，三个`单独占一行

  ``` 
  语句1
  语句2
  语句3
  ``` 
  

  示例：

• 单行代码

  `System.out.println("hello world")`
  

  效果如下：
  System.out.println("hello world")

• 多行代码

  ``` 
  function hello() { 
    console.log("hello, markdown");
  }
  ``` 
  

  效果如下：

  function hello() { 
        console.log("hello, markdown");
  }
  

  注：测试了一下GitHub的Markdown解释器，~也可以解析代码块，语法如下：

  ~~~
  语句1
  语句2
  语句3
  ~~~
  

  示例：

  ~~~
  function exec() {
    console.log("hello, markdown");
  }
  ~~~
  

  效果如下：

  function exec() {
    console.log("hello, markdown");
  }
  

五. 强调

在强调的内容两侧分别加上*或者_，如：
一个*或一个_表示斜体，两个*或_表示粗体，三个*或_表示粗斜体，两个~表示删除线。

*斜体*，_斜体_   
**粗体**，__粗体__   
***粗斜体***，___粗斜体___   
~~这是删除的内容~~

效果如下：
斜体，斜体
粗体，粗体
粗斜体，粗斜体
这是删除的内容

六. 列表

无序列表

无序列表用+，-， *表示，示例如下：

+ 第一项
+ 第二项
+ 第三项   
   
- 第一项
- 第二项
- 第三项
   
* 第一项
* 第二项
* 第三项

效果如下：

• 第一项
• 第二项
• 第三项

列表的嵌套，在第二行的列表下输入一个Tab制表符加上一个-，-和文字之间有一个空格
示例：

* 第一项
	- 第一项子项一
	- 第一项子项二
* 第二项
	- 第二项子项一
	- 第二项子项二

效果如下：

• 第一项
  • 第一项子项一
  • 第一项子项二
• 第二项
  • 第二项子项一
  • 第二项子项二

有序列表

有序列表直接用数字表示，实例如下：

1. 第一项
2. 第二项
3. 第三项
4. 第四项

效果如下：

1. 第一项
2. 第二项
3. 第三项
4. 第四项

注：嵌套实现同无序列表

七. 分割线

三个或三个以上的-、*或_都可以表示分割线，示例：

---
----
***
****
___
____

效果如下：

注：某些编辑器下，-、*或_中间需要加空格，才可以正常解析，例如：未添加markdown插件的vim编辑器

八. 超链接

链接可以用来跳转外部网站，语法如下：

[超链接名](超链接地址 "超链接title")
title可选

示例：

[百度](https://www.baidu.com)

效果如下：
百度

九. 图片

语法：

![图片alt](图片地址 "图片title")
alt是显示在图片下面的文字，是对图片内容的解释说明
title是图片的标题，当鼠标放上去时显示，可选

示例：

![beautiful girl](https://perfiffer.cn/images/beautiful_girl.jpg "beautiful girl")  

效果如下：

十. 表格

语法：

| 列1 | 列2 | 列3 |
| 列名1 | 列名2 | 列名3 |
| 列名1 | 列名2 | 列名3 |

示例：

| 姓名 | 年龄 | 性别 |
| Smith | 20 | male |
| Andy | 22 | female |

效果如下：

注意：编辑时表格要与上一行空一行，否则表格不生效
表格默认左对齐，可以根据需要实现左对齐，居中对齐，右对齐

左对齐：:-表示内容和标题栏左对齐

| 姓名 | 年龄 | 性别 |
| :--- | :--- | :--- |
| Smith | 20 | male |
| Andy | 22 | female |

效果如下：

右对齐：-:表示内容和标题栏居右对齐

| 姓名 | 年龄 | 性别 |
| ---: | ---: | ---: |
| Smith | 20 | male |
| Andy | 22 | female |

效果如下：

居中对齐：:-:表示内容和标题居中对齐

| 姓名 | 年龄 | 性别 |
| :---: | :---: | :---: |
| Smith | 20 | male |
| Andy | 22 | female |

效果如下：

注意：

1. |、-、:之间的多余空格会被忽略，不影响布局
2. 内容和|之间的空格会被忽略，每行第一个|和最后一个|可以省略
3. -的数量至少有一个

十一. 符号和特殊字符

1. 符号
   语法：

   \\	反斜线
   \`	反引号
   \*	星号
   \_	下划线
   \{ \}	花括号
   \[ \]	方括号
   \( \)	括弧
   \#	井号
   \+	加号
   \-	减号
   \.	英文句点号
   \!	惊叹号
   

   效果如下：
   \`*_{}[]()#+-.!

2. 特殊字符 语法：

   ©	版权
   ®	注册商标
   ™	商标
    	空格
   &	和号
   "	引号
   &aqos;	撇号
   <	小于号
   >	大于号
   ≠	不等号
   ≤	小于等于号
   ≥	大于等于号
   ¢	分
   £ 镑
   €	欧元
   ¥	元
   §	节
   ×	乘号
   ÷除号
   ±正负号
   

   效果如下：
   ©
   ®
   ™  
   &
   "
   '
   <
   >
   ≠
   ≤
   ≥
   ¢
   £
   €
   ¥
   §
   ×
   ÷
   ±

十二. 锚点

语法：

[锚点标记](#锚点标记)

效果如下：
锚点标记

锚点标记

锚点指向的是与标题一一对应的。 需要注意以下几点：

1. 如果锚点指向的标题是英文的，()里面的英文字母需要全部小写。

   [Github](#github)
   #### Github
   

2. 多单词的锚点中间的空格用-代替

   [Github Markdown](#github-markdown)
   #### Github Markdown 
   

3. 标题有多级序号，包含.的时候，要去除.

   [1.2.3. Github Markdown](#123-github-markdown)
   #### 1.2.3. Github Markdown
   

十三. 流程图

```flow
st=>start; 开始
op=>operation; Operation
cond=>condition: Yes or No?
e=>end
st->op->cond
cond(yes)->e
cond(no)->op
&```

注：github默认使用的markdown解释器是GFM（GitHub Favorite MarkDown），不支持流程图，如果想要实现路程图的效果，可以通过mermaid实现，mermaid是一款js插件，语法和markdown不一样，此处不做讲解，有兴趣的可以自己研究一下。