GitHub上README语法GFM详解

收集自互联网 

---

README.md，md是markdown的缩写。

Markdown是一种轻量级标记语言，它以纯文本形式（易读易写易更改）编写文档，并最终以HTML格式发布。

Markdown支持一些html标签，但如果完全使用html来写的话，就丧失意义了，毕竟Markdown并非专门做前端的， 然而仅实现一般效果的话，它比html写起来要简介很多！

Markdown也可以理解为将markdown语法编写的语言转换成HTML内容的工具。

不过GitHub支持的语法在标准的markdown语法的基础上做出了修改，称为 GitHub Flavored Markdown，简称GFW。

Markdown语法主要分为如下几大部分：

标题；

段落；

文本；

区块引用；

代码区块；

强调；

列表；

分割线；

链接；

图片；

\反斜杠 ；

`反引号；

标题

使用 “=”等于号 标记一级大标题，“=” 等于号 个数无限制，但必须大于0个；

一级大标题

========

使用 “_”下划线 标记二级中标题，“_”下划线 个数无线，但同样要大于0个；

二级中标题

________

大中标题下面都会有一条横线，这就用于区分与一二级标题。

一、二级大中标题

普通标题

# 一级标题

## 二级标题

### 三级标题

#### 四级标题

##### 五级标题

###### 六级标题

横线

***    #三个星号即以上 可以显示 虚横线效果

---    #三个短横线即以上 可以显示 虚横线效果

__    #三个下划线即以上 可以显示 虚横线效果

段落

段落的前后都要有空行，所谓的空行是指没有文字内容。若想在段内强制换行的方式是使用两个以上空格加回车（引用中换行省略回车）。

文本

普通文本

直接输入的文字就是普通文本。需要注意的是换行的时候不能直接通过回车来换行，需要使用
（或
），也就是HTML里面的标签。此外，要显示一个超链接的话，直接输入这个链接的URL就可以了，显示出来会自动变成可链接的形式。

默认的文本行首部空格都会被忽略，但如果你想用空格来排一下版的话，可以把输入法由 半角改成全角就OK啦。

单行文本

使用两个Tab符实现单行文本。

[tab][tab]一行但行文本

多行文本

只要在每行行首加上两个Tab符就行啦！

文字超链接

[我的网址]（http://www.xxx.com）

图片

添加图片的形式和超链接类似

! [alt] (URL title)

！[]（https://github.com/a.jpg）

锚点

每一个标题都是一个锚点，和HTML的锚点（#）类似

[Top]（#readme）

区块引用

在段落的每行或某一行使用 “>”大于符号，还可以嵌套使用

>1

>>22

>>>333

>>>>4444

嵌套效果图

代码区块

我们需要在代码的上一行和下一行用 “```”三个反引号 标记，注意，需要和普通段落之间存在空行。

```python

from flask import Flask

print("HelloWorld!")

```

代码区块效果图

强调（斜体、粗体、删除线）

*斜体1*，_斜体2_ ；

**粗体1**，__粗体2__ ；

***斜粗体1***，___斜粗体2___ ；

~~删除线~~ ；

# 斜体，粗体，删除线可以混合使用

列表

无序列表

使用  *  标记无序列表，星号后面有一个空格

* ul001

* ul002

* ul003

效果图

* ul01

[tab]* ul001

[tab][tab] *ul0001

分级无序列表

有序列表

就是在数字后面加一个点（.），再加一个空格

1. list01

2. list02

表情

GitHub的Markdown语法支持添加emoji表情，输入不同的符号码（:xxx:）可以显示不同的表情。

：blush： ----->  

具体每一个表情的符号码，可以查看某一博主的GitHub的emoji

diff语法

版本控制的系统中少不了diff的功能，即展示一个文件内容的增加与删除。

GFM中可以展示diff效果，绿色表示新增，红色表示删除。

效果图