README.md 文件的作用和语法

一、README.md 文件的作用

md文件一般出现在项目的根目录下面，其作用是：对项目的主要信息进行描述。
如果一个项目你很长时间都没有动，突然你需要修改这个项目，那么通过README.md中对项目的描述能让你快速的再次上手；或者别人拿到你的项目也能通过README.md文件的描述快速的了解该项目。

二、README.md 的语法

1、标题语法

标题前面有几个“#”，代表是几级标题，注意最后一个“#”号后面有一个空格。
“# 一级标题”
“## 二级标题”
“### 三级标题”

2、文字格式

“ 斜体 ”
“ 粗体 ”
“ 粗斜体 ”
“ 斜体 ”
“ 粗体 ”
“粗斜体”

3、列表原点符号

一个“ * ”加一个空格就会变成一个原点符。
“ * 原点符 ”
效果：

• 原点符

4、缩进

用法：在前面加“>”，有几个就加几个
“>一层”
“>>二层”
“>>>三层”
效果：

一层

二层

三层

5、分割线

用法：只需要三个或者三个以上的“*”、“-”或者“_”就会生成一条分割线

---

---

---

6、删除线

用法：只需要在开头和结尾加上两个“~”，就会生成一条删除线

删除号

7、代码块

片段