技術人員的寫做利器：Markdown

時間 2020-01-05

標籤技術人員利器 markdown 欄目職業生涯简体版

原文原文鏈接

Markdown 是一種輕量級的標記語言，其用簡單的標記語法即可達到排版的目的，其可使咱們更加專一於內容的編寫，而不需過多關注排版。本文主要整理了 Markdown 中的經常使用的標記語法，以便本身與他人之後查用。javascript

段落元素

一、段落與換行

Markdown 中的段落指連續的一段文字，編寫時段落之間用至少一個空行隔開，段落內多個空格將被視爲一個空格，段首不支持縮進。java

若是想要在顯示時顯示多個空行，能夠插入 <br/> 來實現，注意的是，插入的 <br/> 應與先後的段落中間至少空一行。jquery

二、標題

Markdown 支持兩種類型的標題。android

//類型 1
這是一級標題
==========
這是二級標題
----------

//類型 2
# 這是一級標題
## 這是二級標題
...
###### 這是六級標題

從上面能夠看出類型 1 是在標題下面插入 = 或者 - 來標識標題等級，但侷限是其只能表示兩個級別的標題。ios

類型 2 是在標題前面插入 1 - 6 個 # ，表示 6 個等級的標題，這是比較推薦的用法。git

三、引用

Markdown 中使用 > 來引用。咱們能夠在一段文字中的每行開頭加上 > 來表示一段引用文字，也能夠只在一段文字的開頭插入一個 > 來表示，以下面的一、2 兩種方式：github

//方式 1
> 這是一句話
> 這是第二句話

//方式 2
> 這是一句話
這是第二句話

Markdown 支持使用不一樣數量的 > 表示嵌套引用。web

> 這是外層的引用
> > 這是內層的引用

四、無序列表

無序列表使用 -、 + 或 * 來做爲標記。ubuntu

- 第一項
- 第二項
- 第三項

上面的 - 能夠用 +、 *替換。須要注意的是，- 等符號與後面的文字至少空一格空格。markdown

五、有序列表

有序列表使用數字和緊挨着的點號表示。

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

同無序列表同樣，標記符號與後面的文字至少空一格空格。但編輯時的數字對顯示無影響。

2. 第一項
6. 第二項
1. 第三項

上面的例子與前一個顯示的結果徹底一致，但建議編輯時按照數字順序。

列表

有序列表和無序列表的每一項中都可嵌套其餘列表；
在列表項之間要插入段落時，這時須要將列表項之間的段落縮進 4 個空格；
使用 1. 來輸出 1. ;

六、代碼區塊

縮進 4 個空格，須要注意的是，每行代碼都須要至少縮進 4 個空格，不能像段落同樣採用首行標記的偷懶寫法，一個代碼區會一直持續到沒有縮進 4 個空格的那一行。

也能夠用一對三個連續的撇號 ` 來包裹代碼段。

code

有的解釋器還能根據代碼的語言從而給代碼加上語法高亮。

function func() {}

七、分割線

使用三個及以上的 *、 - 或 _來表示一個分割線，符號不能混用，符號之間能夠插入多個空格。須要注意的是，使用 - 來插入分割線時須要與上一個段落至少空一行，不然 Markdown 會將上一行文字解釋爲二級標題。

八、表格

表格是 Markdown 比較複雜的一種表示。

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

上面第二行中的點表明對齊方式，分別是默認（居右）、居中、居左。

行內元素

九、超連接

Markdown 中有三種方式實現超連接。

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

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

方式 1 較爲經常使用，也能夠爲連接的文字加上提示文字，只要在括號中超連接加上空格後添加提示內容便可。

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

方式 2 由連接文字和連接地址組成，不一樣的是二者均由 [] 包裹。連接地址的格式爲：

方括號，裏面輸入連接地址；
緊接着是一個冒號；
冒號後面至少一個空格；
連接地址；
如有提示文字，空格後用引號或者括號包裹提示文字。

下面是完整示例：

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

第三種方式是用 <> 來包裹 URL。

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

十、加粗和斜體

Markdown 使用 * 和 _ 來表示粗體和斜體。

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

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

被偶數個 * 或 _ 包裹的文字顯示加粗效果，被奇數個包裹的爲傾斜效果。

須要注意的是，* 和 - 要成對出現，不能混合使用，也不能只出現一個。同時，標識符號要與標識的文字緊挨着，符號與符號之間、符號文字之間不能有任何空格。

十一、代碼

使用 ` (撇號) 來包裹一小段代碼。

`Hello world.`

若想在代碼中添加撇號，可使用多個撇號包裹裏面須要添加的撇號，但注意裏面的連續的撇號數量不能超過外面的數量。

//顯示一個撇號
`` ` ``
//顯示兩個撇號
``` ``  ```

十二、圖片

圖片的插入方式跟超連接前兩種插入方式相似。

//方式 1
![若是圖片不能顯示，就顯示這段文字](圖片 url)

//方式 2
![若是圖片不能顯示，就顯示這段文字][Image-url]
[Image-url]: 圖片url "這是提示文字"

反斜槓 `\`

咱們常常須要在文章中插入一些特殊符號，而這些符號剛好是前面所講的標識符號，能夠在特殊符號前插入 \ 來直接顯示符號，而不讓 Markdown 來將其解釋爲標識符號。

Markdown 支持如下這些符號前插入 `` 而顯示其原本樣子：

\   反斜線
    `   反引號
    *   星號
    _   底線
    {}  花括號
    []  方括號
    ()  括弧
    #   井字號
    +   加號
    -   減號
    .   英文句點
    !   驚歎號

拓展

其實，市場上有不少的 Markdown 解釋器，它們大都能支持上面所講的語法，但呈現出的樣式每每不一。另外，不一樣的解釋器還能支持其餘本身定義的語法，好比 Github 還能支持 emoji。下面再着重介紹 Github 支持的幾個 Markdown 語法。不過須要注意的是，有些語法只能在 issue 或者 pull request 上使用，這個在後面講每一個語法時會標記（約定：「通用」表示在 Github 任何地方可使用的語法，「特殊」表示只能在 issue 或者 pull request 上使用）。

語法高亮(通用)

上面說過，有的解釋器是可以顯示語法高亮的，Github 就能夠。

任務列表（通用）

- [ ] task one
- [x] task two

用法跟普通列表的用法差很少，只不過在每一項文字前面加了 [ ] 或者 [x]。[ ] 中間有且只有一個空格，表示未完成，另外一個表示已完成。

表格（通用）

Github 支持更簡單的 table 語法。

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

表頭與項用一排 - 分隔開，每一列用 | 分隔開。