經常使用markdown語法

咱們在github或gitlab上託管的項目一般須要一個README.md說明文件，md是markdown的縮寫，下面簡單學習一下markdown的語法,這裏只列一下經常使用的語法，後面有用到再補充吧

代碼

要標記一小段行內代碼，用反引號(``)包起來

如 調用方法：`void method(String param)`，

對應的效果

 

另外還能夠設置代碼高亮，根據代碼類型來選擇，輸入格式爲：

```java (type)
    code here
```

如

``` javascript
function test() {
    console.log("Hello world!");
}
```

對應的效果爲

標題

 用#的數量表示1-6階的標題，#和標題文字之間要有一個空格！

如：

# 標題H1

## 標題H2

### 標題H3

#### 標題H4

##### 標題H5

###### 標題H5

效果爲：

連接

 連接文字都是用 [方括號] 來標記，在方塊括號後面緊接着圓括號並插入網址連接便可(方括號和圓括號之間不要有空格)，若是你還想要加上連接的 title 文字，只要在網址後面，用雙引號把 title 文字包起來便可，如：

[普通連接](https://www.mdeditor.com/) [普通連接帶標題](https://www.mdeditor.com/ "普通連接帶標題")(hover時顯示的名稱) 直接連接：<https://www.mdeditor.com>
 [錨點連接][anchor-id] [anchor-id]: https://www.mdeditor.com/
 [mailto:test.test@gmail.com](mailto:test.test@gmail.com) GFM a-tail link @pandao 郵箱地址自動連接 test.test@gmail.com www@vip.qq.com > @pandao

對應的效果爲：

列表

如：

#### 無序列表（星號）Unordered Lists (*)

* 列表一
* 列表二
* 列表三

#### 無序列表（加號和嵌套）Unordered Lists (+)
+ 列表一
+ 列表二
    + 列表二-1
    + 列表二-2
    + 列表二-3
+ 列表三
    * 列表一
    * 列表二
    * 列表三

#### 有序列表 Ordered Lists (-)

1. 第一行
2. 第二行
3. 第三行

對應的效果爲：

字符效果和橫線等

----

表示一條橫線，效果

**粗體**  __粗體__

*斜體字*      _斜體字_

***粗斜體*** ___粗斜體___

引用

### 引用 Blockquotes

> 引用文本 Blockquotes

效果：

圖片

! + [替代圖片的文字，可空,可是中括號不能爲空] + (路徑 title)

![](https://www.mdeditor.com/images/logos/markdown.png "markdown")

刪除

文本兩端加上兩個~~便可或<s>標籤

~~刪除我~~(有時無論用)

<s>刪除我<s>(my favourite)

Ref:

https://www.mdeditor.com/

http://www.cnblogs.com/rossoneri/p/4446440.html

http://mahua.jser.me/