Markdown語(yǔ)法
注意:Markdown中使用到的語(yǔ)法符號(hào)均為英文符號(hào)
Markdown語(yǔ)法主要分為如下幾大部分:
標(biāo)題,段落树瞭,區(qū)塊引用拇厢,強(qiáng)調(diào)爱谁,列表,分割線孝偎,鏈接访敌,圖片,反斜杠邪媳,符號(hào)等捐顷。
一、 標(biāo)題
標(biāo)題有兩種形式:
第一種:使用=
和-
來(lái)標(biāo)記一級(jí)標(biāo)題和二級(jí)標(biāo)題
一級(jí)標(biāo)題
=======
二級(jí)標(biāo)題
-------
效果如下:
一級(jí)標(biāo)題
二級(jí)標(biāo)題
第二種:使用#
可以表示1~6級(jí)標(biāo)題
# 一級(jí)標(biāo)題
## 二級(jí)標(biāo)題
### 三級(jí)標(biāo)題
#### 四級(jí)標(biāo)題
##### 五級(jí)標(biāo)題
###### 六級(jí)標(biāo)題
效果如下
一級(jí)標(biāo)題
二級(jí)標(biāo)題
三級(jí)標(biāo)題
四級(jí)標(biāo)題
五級(jí)標(biāo)題
六級(jí)標(biāo)題
二雨效、 段落
一個(gè)Markdown段落是由一個(gè)或者多個(gè)連續(xù)的文本行組成,段落的前后需要有一個(gè)以上的空行(空行的定義是該行只包含空格和制表符)废赞。Markdown允許段落內(nèi)強(qiáng)制換行徽龟,方式是使用兩個(gè)以上的空格再加上回車(chē)。
三唉地、 區(qū)塊引用
在段落的每一行使用符號(hào)>
來(lái)表示該段落是區(qū)塊引用据悔,區(qū)塊引用可以嵌套。
例子:
>區(qū)塊引用
>>嵌套引用
效果如下:
區(qū)塊引用
嵌套引用
PS:可以多層嵌套耘沼,類(lèi)似標(biāo)題的語(yǔ)法极颓,通過(guò)添加>
的個(gè)數(shù)來(lái)進(jìn)行多層嵌套,例如三層嵌套使用:>>>
群嗤。
四菠隆、代碼區(qū)塊
要在Markdown中建立代碼區(qū)塊,只需要縮進(jìn)4個(gè)空格或者一個(gè)制表符狂秘。
或者將代碼放在 ``` 符號(hào)劃分的區(qū)域內(nèi)骇径。```后面的單詞表示區(qū)塊內(nèi)的代碼是哪種語(yǔ)言
例:使用 ```
```javascript
console.log("代碼區(qū)塊");
```
效果:
console.log("代碼區(qū)塊");
五、強(qiáng)調(diào)
Markdown使用星號(hào)(*
)或者下劃線(_
)來(lái)標(biāo)記強(qiáng)調(diào)的符號(hào) 者春,一個(gè)符號(hào)表示斜體破衔,兩個(gè)符號(hào)表示粗體。
例子:
*斜體*钱烟, *粗體*
_斜體_晰筛,_粗體_
效果:
斜體,粗體
斜體, 粗體
注意:標(biāo)記符號(hào)和文字之間不能有空格
六拴袭、列表
Markdown支持無(wú)序列表和有序列表
無(wú)序列表使用星號(hào)(*
)读第,加號(hào)(+
)或者減號(hào)(-
)來(lái)標(biāo)記
例子:
使用星號(hào)(
*
)
* 第一項(xiàng)
* 第二項(xiàng)
* 第三項(xiàng)使用加號(hào)(
+
)
+ 第一項(xiàng)
+ 第二項(xiàng)
+ 第三項(xiàng)使用減號(hào)(
-
)
- 第一項(xiàng)
- 第二項(xiàng)
- 第三項(xiàng)
效果:
使用星號(hào)(
*
)
- 第一項(xiàng)
- 第二項(xiàng)
- 第三項(xiàng)
使用加號(hào)(
+
)
- 第一項(xiàng)
- 第二項(xiàng)
- 第三項(xiàng)
使用減號(hào)(
-
)
- 第一項(xiàng)
- 第二項(xiàng)
- 第三項(xiàng)
七、分隔線
在一行中使用三個(gè)以上的星號(hào)(*
)稻扬、減號(hào)(-
)或者下劃線(_
)來(lái)建立一個(gè)分隔線卦方,行內(nèi)不能有其他東西。
例子:
使用星號(hào)(
*
)
***
使用減號(hào)(-
)
---
使用下劃線(_
)
___
效果:
使用星號(hào)(
*
)
使用減號(hào)(
-
)
使用下劃線(
_
)
八泰佳、鏈接
Markdown支持兩種形式的鏈接語(yǔ)法: 行內(nèi)式和參考式盼砍。
不管是哪一種方式尘吗,鏈接文字都是用[方括號(hào)]來(lái)標(biāo)記。
行內(nèi)式只需要在方括號(hào)后緊接著加上(圓括號(hào))并在圓括號(hào)內(nèi)插入鏈接即可浇坐,如果還想加上鏈接的title文字(title文字表示鼠標(biāo)懸浮在該鏈接上時(shí)顯示的提示文字
)睬捶,只要在鏈接后面,用雙引號(hào)把title文字包起來(lái)即可近刘,鏈接和title文字之間需要使用空格來(lái)隔開(kāi)擒贸,title文字是可選的挡逼。
參考式是在方括號(hào)后再接上另一個(gè)方括號(hào)养渴,在第二個(gè)方括號(hào)內(nèi)填入用于辨識(shí)鏈接的標(biāo)識(shí)。title文字和行內(nèi)式一致痢艺,選擇性地加在鏈接之后案淋,用雙引號(hào)包裹起來(lái)座韵。
例子:
行內(nèi)式:
[Markdown語(yǔ)法說(shuō)明](http://www.appinn.com/markdown/ "title文字")參考式:
[Markdown語(yǔ)法說(shuō)明][id]
[id]:http://www.appinn.com/markdown/ "title文字"
效果:
行內(nèi)式:
Markdown語(yǔ)法說(shuō)明(行內(nèi)式)參考式(
有些工具可能未實(shí)現(xiàn),推薦使用行內(nèi)式
):
[Markdown語(yǔ)法說(shuō)明(參考式)][id]
[id]:http://www.appinn.com/markdown/ "title文字"
九踢京、圖片
圖片的使用方式和鏈接的使用方式類(lèi)似誉碴,只是需要在第一個(gè)方括號(hào)前加上!,里面的文字替換為圖片的描述文字瓣距,圖片也支持行內(nèi)式和參考式兩種方式黔帕。
例子:
行內(nèi)式:
參考式(
有些工具可能未實(shí)現(xiàn),推薦使用行內(nèi)式
):
![圖片描述文字][id]
[id]:https://s4.music.126.net/style/web2/img/default/default_album.jpg "title文字"
效果:
行內(nèi)式:
圖片描述文字參考式(
有些工具可能未實(shí)現(xiàn)蹈丸,推薦使用行內(nèi)式
):
![圖片描述文字][id]
[id]:https://s4.music.126.net/style/web2/img/default/default_album.jpg "title文字"
十成黄、反斜杠
反斜杠的作用是轉(zhuǎn)義,轉(zhuǎn)義是指讓特殊符號(hào)表示其原本的意思白华,成為不具有Markdown語(yǔ)法的普通符號(hào)慨默。
Markdown使用了一些特殊符號(hào)來(lái)定義一些文字的格式,例如斜體或粗體弧腥,我們使用*
號(hào)來(lái)標(biāo)記厦取,但是當(dāng)我們需要在頁(yè)面上呈現(xiàn)星號(hào)(*
)而不使用它在Markdown中的語(yǔ)法時(shí),需要在星號(hào)(*
)前加上反斜杠(\
)管搪,形如:\*虾攻。
Markdown支持以下符號(hào)在前面加上反斜杠來(lái)幫助插入普通符號(hào):
\ 反斜杠 \
` 反引號(hào) \`
* 星號(hào) \*
_ 下劃線 \_
{} 花括號(hào) \{}
[] 方括號(hào) \[]
() 圓括號(hào) \()
# 井號(hào) \#
+ 加號(hào) \+
- 減號(hào) \-
. 英文句點(diǎn) \.
! 感嘆號(hào) \!
十一、反引號(hào) `
反引號(hào)起到標(biāo)記作用更鲁。
例如:
`標(biāo)記`
效果:
標(biāo)記
十二霎箍、復(fù)選框
復(fù)選框包含選中和未選中兩種形式。復(fù)選框使用減號(hào)(-
)后緊接一個(gè)方括號(hào)([]
)來(lái)表示澡为。減號(hào)和方括號(hào)之間有一個(gè)空格漂坏,方括號(hào)內(nèi)加上小寫(xiě)英文字母(x
)來(lái)表示選中的復(fù)選框,方括號(hào)內(nèi)加上一個(gè)空格表示未選中的復(fù)選框。
例:
選中:
- [x] 選中的復(fù)選框未選中:
- [ ] 未選中的復(fù)選框
效果:
選中:
- [x] 選中的復(fù)選框
未選中:
- [ ] 未選中的復(fù)選框
十三顶别、表格
使用markdown可以很容易地將數(shù)據(jù)進(jìn)行表格展示谷徙。表格的每一列使用|
隔開(kāi),表頭(header
)和內(nèi)容之間使用---
來(lái)分隔驯绎。
例:
header 1 | header 2 | header 3
---|---|---
row 1 col 1 | row 1 col 2 | row 1 col 3
row 2 col 1 | row 2 col 2 | row 2 col 3
header 1 | header 2 | header 3 |
---|---|---|
row 1 col 1 | row 1 col 2 | row 1 col 3 |
row 2 col 1 | row 2 col 2 | row 2 col 3 |
效果如下:
header 1 | header 2 | header 3 |
---|---|---|
row 1 col 1 | row 1 col 2 | row 1 col 3 |
row 2 col 1 | row 2 col 2 | row 2 col 3 |
Markdown還可實(shí)現(xiàn)流程圖
完慧、甘特圖
、數(shù)學(xué)公式
等剩失,由于這些功能使用較少屈尼,就沒(méi)一一列舉,可以參考文末的參考文檔拴孤,里面有更詳盡的介紹脾歧。
參考文檔鏈接:
Markdown 語(yǔ)法說(shuō)明(簡(jiǎn)體中文版)
有道云筆記Markdown指南
PS:對(duì)于前端程序員推薦一款將Markdown的Text文本的字符串轉(zhuǎn)為Html的工具:showdown
附上該工具的在線預(yù)覽地址:Showdown Live Editor
以及github所使用的Markdown的樣式:GitHub Markdown style