使用markdown语法编辑文档

README

在使用git工具进行项目开发的使用，常常看到在项目中都会有一个.md结尾的README.md文档，这个说明性文件是使用markdown语法书写的对项目进行介绍的文档。
使用Markdown编写的语法自然跟其他格式的文件有所区别，这里将简单对这些语法进行介绍，以方便之后方便地使用markdown进行文档编辑。

Markdown是一种纯文本格式的标记语言。通过简单的标记语法，它可以使普通文本内容具有一定的格式。

Markdown语法

Markdown语法不同的工具或平台采用的标准可能不一样，所以有些语法规则和功能是有差异的。

标题

标题前面加上#空格，一个#是一级标题，二个#是二级标题，以此类推，支持六级标题。语法示例如下：

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

字体

• 加粗

要加粗的文字左右分别用两个*号包起来

• 斜体

倾斜的文字左右两边分别用一个*号或-号包起来

• 斜体加粗

要倾斜和加粗的文字左右分别用三个*号包起来

• 删除线
  要加删除线的文字左右分别用两个~~号包起来

语法示例如下：

**这是加粗的文字**
*这是倾斜的文字*
***这是斜体加粗的文字***
~~这是加删除线的文字~~

超链接

Markdown 支持两种形式的链接语法： 行内式和参考式两种形式，行内式一般使用较多。

行内式（常用）

语法说明：

[超链接名](超链接地址 "超链接标题")

[]里写链接文字，()里写链接地址, ()中的""中可以为链接指定title属性，title属性可加可不加。title属性的效果是鼠标悬停在链接上会出现指定的 title文字。链接地址与链接标题前有一个空格，超链接标题可加可不加。

语法示例：

欢迎访问[我的博客](https://blog.csdn.net/love666666shen)
欢迎访问[我的博客](https://blog.csdn.net/love666666shen "love666666shen的博客主页")

参考式

参考式超链接一般用在学术论文上面，或者另一种情况，如果某一个链接在文章中多处使用，那么使用引用 的方式创建链接将非常好，它可以让你对链接进行统一的管理。

语法说明：
参考式链接分为两部分，文中的写法 [链接文字][链接标记]，在文本的任意位置添加[链接标记]:链接地址 “链接标题”，链接地址与链接标题前有一个空格。

如果链接文字本身可以做为链接标记，你也可以写成[链接文字][]
[链接文字]：链接地址的形式，见代码的最后一行。

语法示例：

我经常去的几个网站[GitHub][1]、[知乎][2]以及[简书][3]
[简书][3]是一个不错的[写作社区][]。

[1]:https://github.com "GitHub"
[2]:https://www.zhihu.com "知乎"
[3]:http://www.jianshu.com "简书"
[写作社区]:http://www.jianshu.com

自动链接

语法说明：
Markdown 支持以比较简短的自动链接形式来处理网址和电子邮件信箱，通过使用<>包起来， Markdown就会自动把它转成链接。一般网址的链接文字就和链接地址一样。

语法示例：

<http://example.com/>
<address@example.com>

图片

语法：
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-R7IkksmB-1575818925227)(图片地址 ‘‘图片title’’)]

图片alt就是显示在图片下面的文字，相当于对图片内容的解释。
图片title是图片的标题，当鼠标移到图片上时显示的内容，title可加可不加。

语法示例：

![blockchain](https://ss0.bdstatic.com/70cFvHSh_Q1YnxGkpoWK1HF6hhy/it/
u=702257389,1274025419&fm=27&gp=0.jpg "区块链")

代码片段

单行代码

单行代码：代码之间分别用一个反引号包起来

代码块

代码块：代码之间分别用三个反引号包起来，且两边的反引号单独占一行

列表

列表分为无序列表和有序列表。

无序列表

语法说明：
使用 *或+或- 表示无序列表。
语法示例：

- 无序列表项 一
- 无序列表项 二
- 无序列表项 三

有序列表

有序列表则使用数字接着一个英文句点.

1. 有序列表项 一
2. 有序列表项 二
3. 有序列表项 三

引用

在引用的文字前加>即可。引用也可以嵌套，如加两个>>三个>>>

语法使用示例：

>这是引用的内容
>>这是引用的内容
>>>>>>>>>>这是引用的内容

目录

在段落中填写 [TOC] 以显示全文内容的目录结构。

表格

语法说明：

不管是哪种方式，第一行为表头，第二行分隔表头和主体部分，第三行开始每一行为一个表格行。
列于列之间用管道符|隔开。原生方式的表格每一行的两边也要有管道符。
第二行还可以为不同的列指定对齐方向。默认为左对齐，在-右边加上:就右对齐。

语法示例：

|学号|姓名|分数|
|-|-|-|
|小明|男|75|
|小红|女|79|
|小陆|男|92|

分割线

语法说明：
三个或者三个以上的 - 或者 * 都可以。

语法示例：

---
----
***
*****

流程图

语法示例：

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

效果：