一、前言

當我們在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}}$

Readme.md常用語法總結