GitHub中README常见的几种编写样式

GitHub中README常见的几种编写样式

前言：最近整理GitHub项目时无意中发现一直没被大家关注的README.md（Markdown
）文件也有自己的一套格式，一篇好看的README文件能让访客们眼前一亮，而且能让你的说明描述显得更加整洁简明。由于作者第一次写博客再加上还是个即将毕业的大学生，本篇纯属个人理解如果有写的不对的地方欢迎大家指出，README的格式有很多，在这里就不都一一介绍了，先介绍几个常用的格式，后面有时间再追加。

一、标题的格式

像Word文档一样，Markdown同样有着相同的一级、二级、三级…标题，如下：

一级标题

# 一级标题

二级标题

## 二级标题

三级标题

### 三级标题

四级标题

#### 四级标题

以此类推，二级标题还可以用等号和减号来定义标题，不过只限二级标题，但是等号或减号必须写在文字的下面，等号和减号的数量可以任意。

二、序列的格式

1.有序列表的书写方式如下：

有序列表只需在数字或字母的“.”后加上空格即可，子列表直接在序数前加上几个空格即可。

1. 有序列表
   i. 有序列表
   ii. 有序列表
2. 有序列表

2.无序列表的书写方式如下：

- 无序列表
- 无序列表
	- 无序列表子列表
	- 无序列表子列表
		- 无序列表二级子列表
		- 无序列表二级子列表

三、引用的格式

细心的小朋友应该已经注意到前面用了好多灰色的方块域，这就是Markdown中的引用方式，很简单，只需使用“>”后面写要写的文字就可以实现了。

引用demo

多重引用：

多层引用

多层引用

多层引用
是不是很有意思

书写方式：

> 多层引用 
>> 多层引用 
>>> 多层引用 
>>> 是不是很有意思

四、链接的格式

通常我们想更方便的让别人清楚哪个项目对应着哪个描述，一般都会在项目描述的下面写入一个链接，这样只需点击这个链接就能进入到对应项目。链接的格式如下：

[这里写你项目的名称](https://github.com/这里写你GitHub项目的URL）

写好的样式就是这样：

国际化登录作业

项目：homework-login

五、表格的格式

怎么能少的了表格的插入，表格格式如下：

table1	vlue
id	1
name	user

像下面这样写就好：

|table1|vlue|
|--|--|
| id | 1 |
| name | user |

六、分割线的格式

分割线也是我们在编辑Markdown常用的格式，需要先空一行，在第二行输入三个“-”或“*”或“_”即可，如下示例：

---

---

---

***

---

___

七、斜体字、粗体字的格式

这个方法也很好记，只需记住粗体是在目标文字前后加两个“*”，斜体是在目标文字前后加一个，粗体加斜体是在目标文字前后加三个。如下：

粗体
斜体
粗体加斜体

这样写：

**粗体**
*斜体*
***粗体加斜体***

八、代码块的使用

在代码的前边加上一个Tab键可以取消所有其他格式，注意在代码块上面留一行空行！如下：

	<h1>这是一个代码块</h1>

---

基本上常用的Markdown的几种格式就是这么多，以后遇见了会再来补上。悄悄告诉你们，CSDN博客的文章就是基于Markdown的格式，不熟练的小伙伴可以在博客上练习一下~