Markdown語法

聲明：本文參考https://www.appinn.com/markdown/，非原創，刪除原文部分不經常使用功能，精簡文字，爲本身參考筆記，修改原文章部分錯別字，若是有錯漏，歡迎聯繫我，請多多指教！

概述

宗旨

Markdown的目標是實現易讀易寫

• 可讀性：以純文本發佈，不會像是由不少標籤或是格式指令所構成
• 易編輯：語法由一些精挑細選的符號組成，其做用一目瞭然

兼容HTML

Markdown的語法目標是：成爲一種適用網絡的書寫語言

• HTML是一種發佈格式，Markdown是一種書寫格式
• Markdown語法種類不多，只對應HTML標記的一小部分
• Markdown的格式語法只涵蓋純文本能夠涵蓋的範圍
• 不在Markdown涵蓋範圍以內的標籤，能夠直接在文檔裏面用HTML撰寫
• 在HTML區塊標籤間的Markdown語法將不會被處理。HTML區塊便籤必須在先後加上空行與其餘內容區隔開，而且在開始與結束標籤不能用製表符或空格來縮進
• 在HTML的區段（行內標籤）間Markdown 語法是有效的，依照我的習慣，能夠直接採用HTML標籤來格式化，而不用Markdown提供的連接或者圖像便籤語法

特殊字符自動轉換

• 在HTML文件中，有兩個字符須要特殊處理：< 和& 。<符號用於起始便籤，&符號用於標記HTML實體，若是想要顯示原型，要寫成<和&

在HTML文件連接標籤在href屬性裏，若是你要連接到:

你必須把網址轉換成

• Markdown會自動將< 和&轉化爲<和&；若是要在文檔中插入一個版權符號©，能夠寫成©
• 在code範圍內，不管是行內和區塊，<和&兩個符號都必定會被轉化成HTML實體，這項特性讓你能夠很容易地用Markdown寫HTML code

區塊元素

段落和換行

• 一個Markdown段落是由一個或多個連續的文本行組成，先後默認各有一個空行,若是想要須要自定義插入空行，在插入初先按兩個以上的空格而後回車

標題

Markdown支持兩種標題的語法，類Setext和類atx形式

• 類Setext利用 = (最高階標題)和 - (第二階階標題)，任何數量的 = 和 - 均可以有效果，例如：

• 類 Atx 形式則是在行首插入 1 到 6 個 # ，對應到標題 1 到 6 階，例如：

能夠選擇性地「閉合」類 atx 樣式的標題

區塊引用Blockquotes

• 在 Markdown 文件中創建一個區塊引用,在每行的最前面加上 > ：

• Markdown 也容許你偷懶只在整個段落的第一行最前面加上 > ：

• 區塊引用能夠嵌套（例如：引用內的引用），只要根據層次加上不一樣數量的 > ：

• 引用的區塊內也可使用其餘的 Markdown 語法，包括標題、列表、代碼區塊等：

列表

Markdown支持有序列表和無序列表

• 有序列表（使用*、+、-做爲列表標記）

• 無序列表（使用數字接着一個英文句點）

上面列表使用的數字並不會影響輸出的HTML結果，上面的列表所產生的HTML標記爲：

注意：

• 有序列表數字不會影響輸出結果，但建議最好按照數字順序來，不只是可讀性和美觀，更由於Markdown將來可能支持有序列表的start屬性。
• 列表項目標記一般是放在最左邊，最多能夠縮進3個空格，項目標記後面則必定要接着至少一個空格或製表符
• 要讓列表看起來更漂亮，最好把內容用固定的縮進整理好，若是你懶，那也行
• 若是列表項目間用空行分開，在輸出HTML時Markdown就會自動將項目內容用<p>標籤包起來
• 列表項目能夠包含多個段落，每一個項目下的段落都必須縮進 4 個空格或是 1 個製表符，每行都縮進會美觀好多，若是你懶惰，也容許不縮進，可是段落第一行必須縮進
• 若是要在列表項目內放進引用，那 > 就須要縮進：

• 若是要放代碼區塊的話，該區塊就須要縮進兩次，也就是 8 個空格或是 2 個製表符：

• 固然，項目列表極可能會不當心產生，像是下面這樣的寫法：

• 換句話說，也就是在行首出現數字-句點-空白，要避免這樣的情況，你能夠在句點前面加上反斜槓。

代碼區塊

在 Markdown 中創建代碼區塊，只要縮進 4 個空格或是 1 個製表符

Markdown 會轉換成：

一個代碼區塊會一直持續到沒有縮進的那一行（或是文件結尾）

使用 Markdown 插入範例用的 HTML 原始碼

會被轉換爲：

代碼區塊中，通常的 Markdown 語法不會被轉換，像是星號便只是星號，這表示你能夠很容易地以 Markdown 語法撰寫 Markdown 語法相關的文件。

分隔線

用三個以上的星號、減號、底線來創建一個分隔線，行內不能有其餘東西。你也能夠在星號或是減號中間插入空格。下面每種寫法均可以創建分隔線：

區段元素

行內式連接

要創建一個行內式的連接，只要在方塊括號後面緊接着圓括號並插入網址連接便可，若是你還想要加上連接的 title 文字，只要在網址後面，用雙引號把 title 文字包起來便可，例如：

會產生：

參考式連接

在連接文字的括號後面再接上另外一個方括號，而在第二個方括號裏面要填入用以辨識連接的標記：（能夠選擇性地在兩個方括號中間加上一個空格）

接着，在文件的任意處，你能夠把這個標記的連接內容定義出來：

連接內容定義的形式爲：

• 方括號（前面能夠選擇性地加上至多三個空格來縮進），裏面輸入連接文字
• 接着一個冒號
• 接着一個以上的空格或製表符
• 接着連接的網址
• 選擇性地接着 title 內容，能夠用單引號、雙引號或是括弧包着

下面這三種連接的定義都是相同：

參考式連接比較好讀，可讓文件更像是瀏覽器最後產生的結果，讓你能夠把一些標記相關的元數據移到段落文字以外，你就能夠增長連接而不讓文章的閱讀感受被打斷。

強調

Markdown使用星號（*）和底線（_）做爲標記強調字詞的符號

• 被 * 或 _ 包圍的字詞會被轉成用 <em> 標籤包圍
• 用兩個 * 或 _ 包起來的話，則會被轉成 <strong>

會轉成：

若是你的 * 和 _ 兩邊都有空白的話，它們就只會被當成普通的符號
若是要在文字先後直接插入普通的星號或底線，你能夠用反斜線：
<pre>*this text is surrounded by literal asterisks*
</pre>

代碼

若是要標記一小段行內代碼，你能夠用反引號把它包起來（`），例如：

會產生：

若是要在代碼區段內插入反引號，你能夠用多個反引號來開啓和結束代碼區段

代碼區段的起始和結束端均可以放入一個空白，起始端後面一個，結束端前面一個，這樣你就能夠在區段的一開始就插入反引號

圖片

行內式

詳細敘述以下：

• 一個驚歎號 !
• 接着一個方括號，裏面放上圖片的替代文字
• 接着一個普通括號，裏面放上圖片的網址，最後還能夠用引號包住並加上 選擇性的 'title' 文字。

參考式

「id」是圖片參考的名稱，圖片參考的定義方式則和連接參考同樣

其餘

自動連接

用方括號包起來， Markdown 就會自動把它轉成連接

Markdown 會轉成：

反斜槓

Markdown 支持如下這些符號前面加上反斜槓來幫助插入普通的符號：