README.md文件

引言：
README.md文件用的是Markdown编写的，所有我们先来看看Markdown的语法

首先在github上面某个项目里面创建一个README.md,然后在里面区编辑内容，如图，

点击edit file在下面输入内容，然后切换到preview changes进行预览，好了废话不说了，下面进入基本语法的练习

一、标题

 语法：#  文字内容

备注：一个#代表一级标题，2个#代表二级标题，依次类推支持6级标题，切记#和文字之间有个空格

#代码# 一级标题
## 二级标题
### 三级标题

二、字体

1、加粗

#内容左右各两个***我是加粗字体**

2、斜体

 #内容左右各一个**我是斜体*

3、斜体和加粗

#内容左右3个*
***我是加粗的斜体内容***

4、删除线

#内容左右个两个~
~~我是删除线~~

三、引用

在引用的文字前面加> ，可以嵌套一直增加下去 >>>>>…

>>我是引用
>>>>我是引用
>>>>>>>>>我是引用
>>>>>>>>>>>>>我是引用

展示效果

四、分割线

三个或者三个以上的 -或者*

---
*****

五、图片

![图片alt](图片地址 ''图片title'')解析：
图片alt就是显示在图片下面的文字，相当于对图片内容的解释。
图片title是图片的标题，当鼠标移到图片上时显示的内容。title可加可不加案例：
![这是熊猫](https://timgsa.baidu.com/timg?image&quality=80&size=b9999_10000&sec=1571068885177&di=d85c9c7f61519d318ef353d8c3f98de9&imgtype=0&src=http%3A%2F%2Fp1.ssl.qhmsg.com%2Ft017cd895d6123f24ab.jpg "熊猫")备注：切记地址和title中间要有空格哦

六、超衔接

[超链接名](超链接地址 "超链接title")
title可加可不加案例：
[这是一个链接](http://www.baidu.com "百度首页")

效果

七、列表

1、无序列表

 + - * 任何一个都可以- 我是无序列表+ 我是无序列表* 我是无序列表备注：符号和文字之间有空格

效果

2、有序列表

1.我是有序列表
2.我是有序列表
3.我是有序列表
4.我是有序列表注意符号和内容之间有空格

3、列表嵌套
下一级向后缩进三个空格

4种组合情况，就不一一列举了

1. 一级有序列表1. 二级有序列表2. 二级有序列表3. 二级有序列表1. 一级有序列表* 二级无序列表* 二级无序列表* 二级无序列表1. 一级有序列表* 二级无序列表* 二级无序列表* 二级无序列表

效果如下：

八、表格

语法：表头|表头|表头
---|:--:|---:
内容|内容|内容
内容|内容|内容第二行分割表头和内容。
- 有一个就行，为了对齐，多加了几个
文字默认居左
-两边加冒号(:) 表示文字居中
-右边加冒号(:) 表示文字居右注：原生的语法两边都要用 | 包起来。此处省略示例：#居左
姓名|年龄|地址|籍贯
:-|:-|:-|:-
刘备|99|三国|山西
诸葛亮|99|三国|陕西
曹操|99|三国|陕西
周瑜|100|三国|陕西#居右
姓名|年龄|地址|籍贯
-:|-:|-:|-:
刘备|99|三国|山西
诸葛亮|99|三国|陕西
曹操|99|三国|陕西
周瑜|100|三国|陕西#居中
姓名|年龄|地址|籍贯
---|:--:|:--:|---:
刘备|99|三国|山西
诸葛亮|99|三国|陕西
曹操|99|三国|陕西
周瑜|100|三国|陕西

效国，依次：居左居右居中

九、代码

1、单行代码，代码用反引号“`”(数字键左边的键)括起来

`我是单行代码`

2、代码块：代码之间分别用三个反引号包起来，且两边的反引号单独占一行

(```)
我是代码块
(```)

注：为了防止转译，前后三个反引号处加了小括号，实际是没有的。这里只是用来演示，实际中去掉两边小括号即可。

效果：

十、流程图
https://www.runoob.com/markdown/md-advance.html

README.md文件相关推荐

springboot 建readme_经验分享：给项目创建和编写README.md文件的步骤
在项目开发过程中,不仅要注意代码的编写质量,也要为合作开发打好基础,尤其是合作开发的时候,同事直接的代码需要熟悉,这就需要在开发的时候进行注释操作,方便别人维护和熟悉代码.除了上述两个重要的点之外,还 ...
README.md 文件的作用和语法
一.README.md 文件的作用 md文件一般出现在项目的根目录下面,其作用是:对项目的主要信息进行描述. 如果一个项目你很长时间都没有动,突然你需要修改这个项目,那么通过README.md中对项目 ...
java项目README.MD文件模板
java项目README.MD文件模板项目简介: 用一两句话简单描述该项目所实现的业务功能: 技术选型: 后端技术栈 springboot mybaits jwt 数据库关系型数据库 mysql ...
教程：readme.md文件基础使用
1.如何在readme.md文件中添加图片: 将图片文件上传到github项目仓库的文件夹下,上传成功后,打开上传的图片,在地址栏得到图片链接并复制,编辑插入到README.md文件中: ![Imag ...
GitHub如何在README.md文件中插入图片
1.首先把图片放到本地文件夹中.push到Github的远程仓库. 2.在浏览器进入远程Github仓库找到图片打开图片.那么当前浏览器链接就是图片地址.复制图片的URL. 3.打开README.md ...
mac 打开Readme.md文件 -- 无需下载软件
情况 mac电脑默认可以使用vs code打开.md结尾的文件,但是打开的内容无法展示图片: 希望能将图片展示出来,类似下图: 步骤谷歌浏览器中打开扩展程序,进入谷歌商城搜索** Markdown ...
写markdown用于Github上readme.md文件
Markdown 文档地址 http://pan.baidu.com/s/1o6nu9To Markdown还有一系列衍生版本,用于扩展Markdown的功能(如表格.脚注.内嵌HTML等等),这些功 ...
GitHub中README.md文件的编辑
https://blog.csdn.net/ljc_563812704/article/details/53464039
github README.md教程
github README.md教程总结 github中README.md通过特殊字符标记和缩进来达到格式控制,也可以用HTML标签来实现格式控制. 教程一: Markdown 的目标是实现「易读易 ...