README.md文件的作用及其文件内容的语法

551 阅读1分钟

持续创作,加速成长!这是我参与「掘金日新计划 · 6 月更文挑战」的第27天,点击查看活动详情

README.md文件一般出现在项目的根目录下,其作用是对项目的主要信息进行描述。

如果一个项目你很长时间都没有动,突然你需要修改这个项目,那么通过README.md中对项目的描述能让你快速的再次上手;

或者别人拿到你的项目也能通过README.md文件的描述快速的了解该项目。

README.md的语法

1.标题,几个“#”就表示几级标题,注意最后一个“#”后面有一个空格:

# 一级标题
## 二级标题
### 三级标题
#错误语法

对应效果:图1

1.png

2.文字格式

*斜体*  (斜体)  
**粗体** (粗体)  
***粗斜体*** (粗斜体)  

_斜体_ (斜体)  
__粗体__ (粗体)  
___粗斜体___ (粗斜体)  

对应效果:图2

2.png

3.添加图片

![月影](https://xxxx.jpg)

对应效果:图3

4.圆点符,一个“*”加一个空格就会变成一个圆点符

* 圆点符  
*错误语法

对应效果:图4

4.png

5.缩进,用法就是在前面加“>”,有几个就加几个

>一层
>>二层
>>>三层

对应效果:图5

5.png

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

***
---
___

对应效果:图6

6.png

7.只需要在开头和结尾加上两个“~”,就会生成一条删除线

~~删除号~~

对应效果:图7

7.png

8.插入代码片段

片段

对应效果:图8

8.png

关注公众号(月影WEB),了解更多的前后端知识; 欢迎大家关注互相交流学习;