一、前言

当我们在GitHub上了解别人的项目的时候，一般都是先看Readme.md，既然这样，如果我们想要让别人了解我们的项目，就不能随随便便地写Readme.md了。那Readme.md怎么写呢？Readme.md是有特定的语法规则的，称之为Markdown语法，我这里总结一些常用的语法，觉得有用就推荐一下吧。

二、语法

这里我先推荐一个在线的Markdown编辑器：https://stackedit.io，可以用这个编辑器熟悉下语法。

1.标题

几个“#”就表示几级标题，注意最后一个“#”后面有一个空格：

# h1 （一级标题）

## h2（二级标题）

### h3（三级标题）

2.文字格式

主要是粗体斜体的设置，用“*”和“_”都可以：

*斜体*  （斜体）
**粗体** （粗体）
***粗斜体*** （粗斜体）

_斜体_ （斜体）
__粗体__ （粗体）
___粗斜体___ （粗斜体）

 3.代码

添加代码：

`print("Hello World")` 

还可以设置代码块高亮：

```　　　　　　　　 

print("Hello World")

```

4.引用

添加图片：


添加链接：

[博客园](https://www.cnblogs.com)

5.符号

（1）换行符，注意在Readme.md中不是敲个Enter就换行了，而是在前一行的末尾加上两个空格：

（2）圆点符，一个“*”加一个空格就会变成一个圆点符：

（3）特殊符号： 

6.单行文本

用法就是在开头加上两个Tab，效果如下：

7.缩进

缩进好理解，用法就是在前面加“>”：

>数据结构
>>树
>>>二叉树

 8.分割线

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

***
---
___

9.删除线

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

~~删除线~~

10.数学公式

使用一对“$$”符号引用公式：

$\sqrt{x^{2}}$