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

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

## README.md的语法

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

对应效果:图1

 

### 2.文字格式
*斜体*  (斜体)  
**粗体** (粗体)  
***粗斜体*** (粗斜体)  

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

对应效果:图2

 

### 3.添加图片

![月影](http://web.yydpt.com/yueyingweb.jpg)

对应效果:图3
("wei   xin:【月影WEB】")

 

### 4.圆点符,一个“*”加一个空格就会变成一个圆点符
* 圆点符  
*错误语法

对应效果:图4

 

### 5.缩进,用法就是在前面加“>”,有几个就加几个
>一层
>>二层
>>>三层

对应效果:图5

 

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

对应效果:图6

 

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

对应效果:图7

 

### 8.插入代码片段
```
片段
```

对应效果:图8

 

  • 4
    点赞
  • 10
    收藏
  • 打赏
    打赏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
©️2022 CSDN 皮肤主题:深蓝海洋 设计师:CSDN官方博客 返回首页
评论

打赏作者

月影WEB

你的鼓励将是我创作的最大动力

¥2 ¥4 ¥6 ¥10 ¥20
输入1-500的整数
余额支付 (余额:-- )
扫码支付
扫码支付:¥2
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、C币套餐、付费专栏及课程。

余额充值