1. 程式人生 > >MarkDown學習筆記

MarkDown學習筆記

level reference 根據 con 回車 ron quotes attr with

區塊元素

段落和換行

一個 Markdown 段落是由一個或多個連續的文本行組成,它的前後要有一個以上的空行(空行的定義是顯示上看起來像是空的,便會被視為空行。比方說,若某一行只包含空格和制表符,則該行也會被視為空行)。普通段落不該用空格或制表符來縮進。

如果你確實想要依賴 Markdown 來插入<br />標簽的話,在插入處先按入兩個以上的空格然後回車.

標題

Markdown 支持兩種標題的語法,類 Setext 和類 atx 形式。
類 Setext 形式是用底線的形式,利用 = (最高階標題)和 - (第二階標題),例如:

This is an H1

This is an H2

任何數量的 = 和 - 都可以有效果。

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

這是 H1

這是 H2

這是 H6

你可以選擇性地「閉合」類 atx 樣式的標題,這純粹只是美觀用的,若是覺得這樣看起來比較舒適,你就可以在行尾加上#,而行尾的 # 數量也不用和開頭一樣(行首的井字符數量決定標題的階數):

這是 H1

這是 H2

這是 H3

區塊引用 Blockquotes

Markdown 標記區塊引用是使用類似 email 中用 > 的引用方式

This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.

Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
id sem consectetuer libero luctus adipiscing.

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

This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.

Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
id sem consectetuer libero luctus adipiscing.

區塊引用可以嵌套(例如:引用內的引用),只要根據層次加上不同數量的 > :

This is the first level of quoting.

This is nested blockquote.

Back to the first level.

引用的區塊內也可以使用其他的 Markdown 語法,包括標題、列表、代碼區塊等:

列表

Markdown 支持有序列表和無序列表。
無序列表使用星號、加號或是減號作為列表標記:

  • Red
  • Green
  • Blue

有序列表則使用數字接著一個英文句點:

  1. Bird
  2. McHale
  3. Parish

很重要的一點是,你在列表標記上使用的數字並不會影響輸出的 HTML 結果.

列表項目標記通常是放在最左邊,但是其實也可以縮進,最多 3 個空格,項目標記後面則一定要接著至少一個空格或制表符

如果列表項目間用空行分開,在輸出 HTML 時 Markdown 就會將項目內容用 <p> 標簽包起來。

列表項目可以包含多個段落,每個項目下的段落都必須縮進 4 個空格或是 1 個制表符。如果你每行都有縮進,看起來會看好很多,當然,再次地,如果你很懶惰,Markdown 也允許只縮進首行和末行。

如果要在列表項目內放進引用,那 > 就需要縮進:

如果要放代碼區塊的話,該區塊就需要縮進兩次,也就是 8 個空格或是 2 個制表符。

在行首出現數字-句點-空白,要避免這樣的狀況,你可以在句點前面加上反斜杠。不然會成為有序列表項

代碼區塊

要在 Markdown 中建立代碼區塊很簡單,只要簡單地縮進 4 個空格或是 1 個制表符就可以。這個每行一階的縮進(4 個空格或是 1 個制表符),都會被移除。一個代碼區塊會一直持續到沒有縮進的那一行(或是文件結尾)。在代碼區塊裏面, & 、 < 和 > 會自動轉成 HTML 實體

代碼區塊中,一般的 Markdown 語法不會被轉換。

分隔線

你可以在一行中用三個以上的星號、減號、底線來建立一個分隔線,行內不能有其他東西。你也可以在星號或是減號中間插入空格。下面每種寫法都可以建立分隔線。
* *
****
- - -
---------------------------------------

區段元素

鏈接

Markdown 支持兩種形式的鏈接語法: 行內式和參考式兩種形式。不管是哪一種,鏈接文字都是用 [方括號] 來標記。

要建立一個行內式的鏈接,只要在方塊括號後面緊接著圓括號並插入網址鏈接即可,如果你還想要加上鏈接的 title 文字,只要在網址後面,用雙引號把 title 文字包起來即可,可以使用相對路徑 例如:

This is an example inline link.

This link has no title attribute.

參考式的鏈接是在鏈接文字的括號後面再接上另一個方括號,而在第二個方括號裏面要填入用以辨識鏈接的標記:
接著,在文件的任意處,你可以把這個標記的鏈接內容定義出來。

例如:
This is [an example][id] reference-style link.
[id]: http://example.com/ "Optional Title Here"

例如:
I get 10 times more traffic from [Google] [1] than from [Yahoo] [2] or [MSN] [3].
[1]: http://google.com/ "Google"
[2]: http://search.yahoo.com/ "Yahoo Search"
[3]: http://search.msn.com/ "MSN Search"

鏈接內容定義的形式為:  
方括號(前面可以選擇性地加上至多三個空格來縮進),裏面輸入鏈接文字
接著一個冒號
接著一個以上的空格或制表符   
接著鏈接的網址
選擇性地接著 title 內容,可以用單引號、雙引號或是括弧包著

隱式鏈接標記功能讓你可以省略指定鏈接標記。
[Google][]
[Google]: http://google.com/

強調

Markdown 使用星號(*)和底線(_)作為標記強調字詞的符號,被 *_ 包圍的字詞會被轉成用 <em> 標簽包圍,用兩個 *_ 包起來的話,則會被轉成 <strong>

如果你的 * 和 _ 兩邊都有空白的話,它們就只會被當成普通的符號。

代碼

如果要標記一小段行內代碼,你可以用反引號把它包起來(`)。

如果要在代碼區段內插入反引號,你可以用多個反引號來開啟和結束代碼區段。

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

A single backtick in a code span: `

A backtick-delimited string in a code span: `foo`

在代碼區段內,& 和方括號都會被自動地轉成 HTML 實體,這使得插入 HTML 原始碼變得很容易。

圖片

Markdown 使用一種和鏈接很相似的語法來標記圖片,同樣也允許兩種樣式: 行內式和參考式。

詳細敘述如下:
一個驚嘆號 !
接著一個方括號,裏面放上圖片的替代文字
接著一個普通括號,裏面放上圖片的網址,最後還可以用引號包住並加上 選擇性的 ‘title‘ 文字。

到目前為止, Markdown 還沒有辦法指定圖片的寬高,如果你需要的話,你可以使用普通的 技術分享圖片 標簽。

其它

自動鏈接

Markdown 支持以比較簡短的自動鏈接形式來處理網址和電子郵件信箱,只要是用方括號包起來, Markdown 就會自動把它轉成鏈接。
[email protected]

反斜杠

Markdown 可以利用反斜杠來插入一些在語法中有其它意義的符號,例如:如果你想要用星號加在文字旁邊的方式來做出強調效果(但不用 <em> 標簽),你可以在星號的前面加上反斜杠。

Markdown 支持以下這些符號前面加上反斜杠來幫助插入普通的符號。

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

MarkDown學習筆記