Markdown

Markdown 是一種輕量級(jí)的標(biāo)記語(yǔ)言占遥,其用簡(jiǎn)單的標(biāo)記語(yǔ)法便可達(dá)到排版的目的堕伪,其可以使我們更加專(zhuān)注于內(nèi)容的編寫(xiě),而不需過(guò)多關(guān)注排版。本文主要整理了 Markdown 中的常用的標(biāo)記語(yǔ)法卧波,以便自己與他人以后查用。

段落元素

1庇茫、段落與換行

Markdown 中的段落指連續(xù)的一段文字港粱,編寫(xiě)時(shí)段落之間用至少一個(gè)空行隔開(kāi),段落內(nèi)多個(gè)空格將被視為一個(gè)空格旦签,段首不支持縮進(jìn)查坪。

如果想要在顯示時(shí)顯示多個(gè)空行,可以插入 <br/> 來(lái)實(shí)現(xiàn)宁炫,注意的是偿曙,插入的 <br/> 應(yīng)與前后的段落中間至少空一行。

2羔巢、標(biāo)題

Markdown 支持兩種類(lèi)型的標(biāo)題望忆。

//類(lèi)型 1
這是一級(jí)標(biāo)題
==========
這是二級(jí)標(biāo)題
----------

//類(lèi)型 2
# 這是一級(jí)標(biāo)題
## 這是二級(jí)標(biāo)題
...
###### 這是六級(jí)標(biāo)題

從上面可以看出類(lèi)型 1 是在標(biāo)題下面插入 = 或者 - 來(lái)標(biāo)識(shí)標(biāo)題等級(jí),但局限是其只能表示兩個(gè)級(jí)別的標(biāo)題竿秆。

類(lèi)型 2 是在標(biāo)題前面插入 1 - 6 個(gè) # 启摄,表示 6 個(gè)等級(jí)的標(biāo)題,這是比較推薦的用法袍辞。

3鞋仍、引用

Markdown 中使用 > 來(lái)引用。我們可以在一段文字中的每行開(kāi)頭加上 > 來(lái)表示一段引用文字搅吁,也可以只在一段文字的開(kāi)頭插入一個(gè) > 來(lái)表示威创,如下面的 1、2 兩種方式:

//方式 1
> 這是一句話(huà)
> 這是第二句話(huà)

//方式 2
> 這是一句話(huà)
這是第二句話(huà)

Markdown 支持使用不同數(shù)量的 > 表示嵌套引用谎懦。

> 這是外層的引用
> > 這是內(nèi)層的引用

4肚豺、無(wú)序列表

無(wú)序列表使用 -+* 來(lái)作為標(biāo)記界拦。

- 第一項(xiàng)
- 第二項(xiàng)
- 第三項(xiàng)

上面的 - 可以用 +吸申、 *替換。需要注意的是享甸,- 等符號(hào)與后面的文字至少空一格空格截碴。

5、有序列表

有序列表使用數(shù)字和緊挨著的點(diǎn)號(hào)表示蛉威。

1. 第一項(xiàng)
2. 第二項(xiàng)
3. 第三項(xiàng)

同無(wú)序列表一樣日丹,標(biāo)記符號(hào)與后面的文字至少空一格空格。但編輯時(shí)的數(shù)字對(duì)顯示無(wú)影響蚯嫌。

2. 第一項(xiàng)
6. 第二項(xiàng)
1. 第三項(xiàng)

上面的例子與前一個(gè)顯示的結(jié)果完全一致哲虾,但建議編輯時(shí)按照數(shù)字順序丙躏。

列表

  • 有序列表和無(wú)序列表的每一項(xiàng)中均可嵌套其他列表;

  • 在列表項(xiàng)之間要插入段落時(shí)束凑,這時(shí)需要將列表項(xiàng)之間的段落縮進(jìn) 4 個(gè)空格晒旅;

  • 使用 1\. 來(lái)輸出 1.;

6、代碼區(qū)塊

縮進(jìn) 4 個(gè)空格汪诉,需要注意的是废恋,每行代碼都需要至少縮進(jìn) 4 個(gè)空格,不能像段落一樣采用首行標(biāo)記的偷懶寫(xiě)法扒寄,一個(gè)代碼區(qū)會(huì)一直持續(xù)到?jīng)]有縮進(jìn) 4 個(gè)空格的那一行拴签。

也可以用一對(duì)三個(gè)連續(xù)的撇號(hào) ` 來(lái)包裹代碼段。

```
code
```

有的解釋器還能根據(jù)代碼的語(yǔ)言從而給代碼加上語(yǔ)法高亮旗们。

```javascript
function func() {}
```

7、分割線(xiàn)

使用三個(gè)及以上的 *构灸、 -_來(lái)表示一個(gè)分割線(xiàn)上渴,符號(hào)不能混用,符號(hào)之間可以插入多個(gè)空格喜颁。需要注意的是稠氮,使用 - 來(lái)插入分割線(xiàn)時(shí)需要與上一個(gè)段落至少空一行,否則 Markdown 會(huì)將上一行文字解釋為二級(jí)標(biāo)題半开。

8隔披、表格

表格是 Markdown 比較復(fù)雜的一種表示。

| Table | Col1 | Col2 |
| ----- |:----:| ----:|
| Row1  | 1-1  | 1-2  |
| Row2  | 2-1  | 2-2  |
| Row3  | 3-1  | 3-2  |

上面第二行中的點(diǎn)代表對(duì)齊方式寂拆,分別是默認(rèn)(居右)奢米、居中、居左纠永。


行內(nèi)元素

9鬓长、超鏈接

Markdown 中有三種方式實(shí)現(xiàn)超鏈接。

//方式 1
[百度](http://www.baidu.com)

//方式 2
[百度][Baidu-url]
[Baidu-url]: http://www.baidu.com

方式 1 較為常用尝江,也可以為鏈接的文字加上提示文字涉波,只要在括號(hào)中超鏈接加上空格后添加提示內(nèi)容即可。

[百度](http://www.baidu.com "這是提示文字")

方式 2 由鏈接文字和鏈接地址組成炭序,不同的是兩者均由 [] 包裹啤覆。鏈接地址的格式為:

  • 方括號(hào),里面輸入鏈接地址惭聂;
  • 緊接著是一個(gè)冒號(hào)窗声;
  • 冒號(hào)后面至少一個(gè)空格;
  • 鏈接地址彼妻;
  • 若有提示文字嫌佑,空格后用引號(hào)或者括號(hào)包裹提示文字豆茫。

下面是完整示例:

[百度][Baidu-url]
[Baidu-url]: http://www.baidu.com "這是提示文字"

第三種方式是用 <> 來(lái)包裹 URL。

//方式 3
<http://www.baidu.com>

10屋摇、加粗和斜體

Markdown 使用 *_ 來(lái)表示粗體和斜體揩魂。

//加粗
**這是加粗文字**
__這也是加粗文字__

//斜體
*這是斜體文字*
_這也是斜體文字_

被偶數(shù)個(gè) *_ 包裹的文字顯示加粗效果,被奇數(shù)個(gè)包裹的為傾斜效果炮温。

需要注意的是火脉,*- 要成對(duì)出現(xiàn),不能混合使用柒啤,也不能只出現(xiàn)一個(gè)倦挂。同時(shí),標(biāo)識(shí)符號(hào)要與標(biāo)識(shí)的文字緊挨著担巩,符號(hào)與符號(hào)之間方援、符號(hào)文字之間不能有任何空格。

11涛癌、代碼

使用 ` (撇號(hào)) 來(lái)包裹一小段代碼犯戏。

`Hello world.`

若想在代碼中添加撇號(hào),可以使用多個(gè)撇號(hào)包裹里面需要添加的撇號(hào)拳话,但注意里面的連續(xù)的撇號(hào)數(shù)量不能超過(guò)外面的數(shù)量先匪。

//顯示一個(gè)撇號(hào)
`` ` ``
//顯示兩個(gè)撇號(hào)
``` ``  ```

12、圖片

圖片的插入方式跟超鏈接前兩種插入方式類(lèi)似弃衍。

//方式 1
![](圖片 url)

//方式 2
![如果圖片不能顯示呀非,就顯示這段文字][Image-url]
[Image-url]: 圖片url "這是提示文字"

反斜杠 \

我們經(jīng)常需要在文章中插入一些特殊符號(hào),而這些符號(hào)恰好是前面所講的標(biāo)識(shí)符號(hào)镜盯,可以在特殊符號(hào)前插入 \ 來(lái)直接顯示符號(hào)岸裙,而不讓 Markdown 來(lái)將其解釋為標(biāo)識(shí)符號(hào)。

Markdown 支持以下這些符號(hào)前插入 \ 而顯示其本來(lái)樣子:

    \   反斜線(xiàn)
    `   反引號(hào)
    *   星號(hào)
    _   底線(xiàn)
    {}  花括號(hào)
    []  方括號(hào)
    ()  括弧
    #   井字號(hào)
    +   加號(hào)
    -   減號(hào)
    .   英文句點(diǎn)
    !   驚嘆號(hào)

拓展

其實(shí)速缆,市場(chǎng)上有很多的 Markdown 解釋器哥桥,它們大都能支持上面所講的語(yǔ)法,但呈現(xiàn)出的樣式往往不一激涤。另外拟糕,不同的解釋器還能支持其他自己定義的語(yǔ)法,比如 Github 還能支持 emoji倦踢。下面再著重介紹 Github 支持的幾個(gè) Markdown 語(yǔ)法送滞。不過(guò)需要注意的是,有些語(yǔ)法只能在 issue 或者 pull request 上使用辱挥,這個(gè)在后面講每個(gè)語(yǔ)法時(shí)會(huì)標(biāo)記(約定:“通用”表示在 Github 任何地方可以使用的語(yǔ)法犁嗅,“特殊”表示只能在 issue 或者 pull request 上使用)。

語(yǔ)法高亮(通用)

上面說(shuō)過(guò)晤碘,有的解釋器是能夠顯示語(yǔ)法高亮的褂微,Github 就可以功蜓。

任務(wù)列表(通用)

- [ ] task one
- [x] task two

用法跟普通列表的用法差不多,只不過(guò)在每一項(xiàng)文字前面加了 [ ] 或者 [x]宠蚂。[ ] 中間有且只有一個(gè)空格式撼,表示未完成,另一個(gè)表示已完成求厕。

表格(通用)

Github 支持更簡(jiǎn)單的 table 語(yǔ)法著隆。

First Header | Second Header
------------ | -------------
Content from cell 1 | Content from cell 2
Content in the first column | Content in the second column

表頭與項(xiàng)用一排 - 分隔開(kāi),每一列用 | 分隔開(kāi)呀癣。

SHA 引用(特殊)

每一次 commit 都會(huì)產(chǎn)生一個(gè) id美浦,用 @id 的方式可以鏈接到某個(gè)項(xiàng)目的特定的 commit。比如用 jquery/jquery@1b9575b9d14399e9426b9eacdd92b3717846c3f2 就能鏈接到 jquery 的一次 commit 記錄上项栏。

issue 引用(特殊)

#1 來(lái)引用當(dāng)前 repo 的第一個(gè) issue浦辨,也可以用 jquery/jquery#1 引用 jquery 的第一次 issue。

@(特殊)

@ 來(lái)提醒目標(biāo)用戶(hù)沼沈。比如 @CompileYouth 可以 @ 到我荤牍。

刪除符號(hào)(通用)

用連續(xù)兩個(gè) ~ 包圍的詞會(huì)被加上刪除符。比如 ~~This is removed~~庆冕。

Emoji(通用)

Github 比較有意思的是可以支持 emoji。比如 :smile: 表示笑臉等等劈榨,具體可以查看 Emoji Cheat Sheet

詳細(xì)信息可以查看官方文檔访递。最后 po 兩張 Github 官方推薦的 Markdown Cheat Sheet:通用語(yǔ)法Github 支持語(yǔ)法

工具

  • Windows 環(huán)境下同辣,推薦 Typora拷姿、Markdownpad(自帶圖床功能)
  • Mac 環(huán)境下,推薦 Typora旱函、Mou
  • 筆記軟件: 為知筆記較好的支持 markdown响巢,且支持 Windows、Mac棒妨、web踪古、ios、android 等各個(gè)平臺(tái)
  • 當(dāng)然券腔,還有 Github

實(shí)踐

Markdown 文件的編輯在不同編輯器中有不一樣的表現(xiàn)伏穆,我主要介紹一下在 Atom 中使用 Markdown 的情況。

Atom 官方自帶了一個(gè)插件纷纫,叫 markdown-preview枕扫,可以在 Atom 中進(jìn)行預(yù)覽。當(dāng)然辱魁,Atom 還有很多第三方的 Markdown 插件烟瞧,我使用的是 markdown-writer诗鸭,可以使我更方便地編輯 Markdown 文件,當(dāng)然你可以根據(jù)自己的需要下載插件参滴。

在 Atom 中强岸,其他的使用方式就不贅述了,唯一需要提一下的是插入 table卵洗。在 Markdown 中插入 table 是一件比較麻煩的事情请唱,而在 Atom 中,可以簡(jiǎn)化操作过蹂,就是直接輸入 table 然后按 Enter 鍵十绑,編輯器便會(huì)自動(dòng)生成 table 的模板,比自己手寫(xiě)便捷多了酷勺。

拓展閱讀:

  1. Markdown 語(yǔ)法說(shuō)明

!!!轉(zhuǎn)自:https://github.com/CompileYouth/front-end-study/blob/master/tool/markdown/Markdown-Learning.md

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末本橙,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子脆诉,更是在濱河造成了極大的恐慌甚亭,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,941評(píng)論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件击胜,死亡現(xiàn)場(chǎng)離奇詭異亏狰,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)偶摔,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,397評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門(mén)暇唾,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人辰斋,你說(shuō)我怎么就攤上這事策州。” “怎么了宫仗?”我有些...
    開(kāi)封第一講書(shū)人閱讀 165,345評(píng)論 0 356
  • 文/不壞的土叔 我叫張陵够挂,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我藕夫,道長(zhǎng)孽糖,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,851評(píng)論 1 295
  • 正文 為了忘掉前任毅贮,我火速辦了婚禮梭姓,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘嫩码。我一直安慰自己誉尖,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,868評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布铸题。 她就那樣靜靜地躺著铡恕,像睡著了一般琢感。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上探熔,一...
    開(kāi)封第一講書(shū)人閱讀 51,688評(píng)論 1 305
  • 那天驹针,我揣著相機(jī)與錄音,去河邊找鬼诀艰。 笑死柬甥,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的其垄。 我是一名探鬼主播苛蒲,決...
    沈念sama閱讀 40,414評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼绿满!你這毒婦竟也來(lái)了臂外?” 一聲冷哼從身側(cè)響起,我...
    開(kāi)封第一講書(shū)人閱讀 39,319評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤喇颁,失蹤者是張志新(化名)和其女友劉穎漏健,沒(méi)想到半個(gè)月后,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體橘霎,經(jīng)...
    沈念sama閱讀 45,775評(píng)論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡蔫浆,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,945評(píng)論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了姐叁。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片瓦盛。...
    茶點(diǎn)故事閱讀 40,096評(píng)論 1 350
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖七蜘,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情墙懂,我是刑警寧澤橡卤,帶...
    沈念sama閱讀 35,789評(píng)論 5 346
  • 正文 年R本政府宣布,位于F島的核電站损搬,受9級(jí)特大地震影響碧库,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜巧勤,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,437評(píng)論 3 331
  • 文/蒙蒙 一嵌灰、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧颅悉,春花似錦沽瞭、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,993評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)城丧。三九已至,卻和暖如春豌鹤,著一層夾襖步出監(jiān)牢的瞬間亡哄,已是汗流浹背。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,107評(píng)論 1 271
  • 我被黑心中介騙來(lái)泰國(guó)打工布疙, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留蚊惯,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 48,308評(píng)論 3 372
  • 正文 我出身青樓灵临,卻偏偏與公主長(zhǎng)得像截型,于是被迫代替她去往敵國(guó)和親。 傳聞我的和親對(duì)象是個(gè)殘疾皇子俱诸,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,037評(píng)論 2 355

推薦閱讀更多精彩內(nèi)容