區段元素
強調(斜體、粗體)
Markdown 使用星號(*
)和底線(_
)作爲標記強調字詞的符號,被 *
或_
包圍的字詞會被轉成用 <em>
標籤包圍(斜體),用兩個 * 或 _ 包起來的話,則會被轉成 <strong>
(加粗),例如:
*single asterisks*
_single underscores_
**double asterisks**
__double underscores__
會轉成:
<em>single asterisks</em>
<em>single underscores</em>
<strong>double asterisks</strong>
<strong>double underscores</strong>
你可以隨便用你喜歡的樣式,唯一的限制是,你用什麼符號開啓標籤,就要用什麼符號結束。
強調也可以直接插在文字中間:
un*frigging*believable
但是如果你的 *
和_
兩邊都有空白的話,它們就只會被當成普通的符號。
如果要在文字前後直接插入普通的星號或底線,你可以用反斜線:
\*this text is surrounded by literal asterisks\*
代碼
如果要標記一小段行內代碼,你可以用反引號把它包起來(`
),例如:
Use the `printf()` function.
會產生:
<p>Use the <code>printf()</code> function.</p>
如果要在代碼區段內插入反引號,你可以用多個反引號來開啓和結束代碼區段:
``There is a literal backtick (`) here.``
這段語法會產生:
<p><code>There is a literal backtick (`) here.</code></p>
代碼區段的起始和結束端都可以放入一個空白,起始端後面一個,結束端前面一個,這樣你就可以在區段的一開始就插入反引號:
A single backtick in a code span: `` ` ``
A backtick-delimited string in a code span: `` `foo` ``
會產生:
<p>A single backtick in a code span: <code>`</code></p>
<p>A backtick-delimited string in a code span: <code>`foo`</code></p>
在代碼區段內,& 和尖括號都會被自動地轉成 HTML 實體,這使得插入 HTML 原始碼變得很容易,Markdown 會把下面這段:
Please don't use any `<blink>` tags.
轉爲:
<p>Please don't use any <code><blink></code> tags.</p>
你也可以這樣寫:
`—` is the decimal-encoded equivalent of `—`.
以產生:
<p><code>&#8212;</code> is the decimal-encoded equivalent of <code>&mdash;</code>.</p>
圖片
很明顯地,要在純文字應用中設計一個「自然」的語法來插入圖片是有一定難度的。
Markdown 使用一種和鏈接很相似的語法來標記圖片,同樣也允許兩種樣式: 行內式和參考式。
行內式的圖片語法看起來像是:
![Alt text](/path/to/img.jpg)
![Alt text](/path/to/img.jpg "Optional title")
詳細敘述如下:
- 一個驚歎號 !
- 接着一個方括號,裏面放上圖片的替代文字
- 接着一個普通括號,裏面放上圖片的網址
最後還可以用引號包住並加上 選擇性的 ‘title’ 文字。
參考式的圖片語法則長得像這樣:
![Alt text][id]
「id」是圖片參考的名稱,圖片參考的定義方式則和連結參考一樣:
[id]: url/to/image "Optional title attribute"
到目前爲止, Markdown 還沒有辦法指定圖片的寬高,如果你需要的話,你可以使用普通的 <img>
標籤。
鏈接
Markdown 支持兩種形式的鏈接語法: 行內式和參考式兩種形式。
不管是哪一種,鏈接文字都是用 [方括號] 來標記。
要建立一個行內式的鏈接,只要在方塊括號後面緊接着圓括號並插入網址鏈接即可,如果你還想要加上鍊接的 title 文字,只要在網址後面,用雙引號把 title 文字包起來即可,例如:
This is [an example](http://example.com/ "Title") inline link.
[This link](http://example.net/) has no title attribute.
會產生:
<p>This is <a href="http://example.com/" title="Title">an example</a> inline link.</p>
<p><a href="http://example.net/">This link</a> has no title attribute.</p>
如果你是要鏈接到同樣主機的資源,你可以使用相對路徑:
See my [About](/about/) page for details.
參考式的鏈接是在鏈接文字的括號後面再接上另一個方括號,而在第二個方括號裏面要填入用以辨識鏈接的標記:
This is [an example][id] reference-style link.
你也可以選擇性地在兩個方括號中間加上一個空格:
This is [an example] [id] reference-style link.
接着,在文件的任意處,你可以把這個標記的鏈接內容定義出來:
[id]: http://example.com/ "Optional Title Here"
鏈接內容定義的形式爲:
- 方括號(前面可以選擇性地加上至多三個空格來縮進),裏面輸入鏈接文字
- 接着一個冒號
- 接着一個以上的空格或製表符
- 接着鏈接的網址
選擇性地接着 title 內容,可以用單引號、雙引號或是括弧包着
下面這三種鏈接的定義都是相同:
[foo]: http://example.com/ "Optional Title Here"
[foo]: http://example.com/ 'Optional Title Here'
[foo]: http://example.com/ (Optional Title Here)
請注意:有一個已知的問題是 Markdown.pl 1.0.1 會忽略單引號包起來的鏈接 title。
鏈接網址也可以用尖括號包起來:
[id]: <http://example.com/> "Optional Title Here"
你也可以把 title 屬性放到下一行,也可以加一些縮進,若網址太長的話,這樣會比較好看:
[id]: http://example.com/longish/path/to/resource/here
"Optional Title Here"
網址定義只有在產生鏈接的時候用到,並不會直接出現在文件之中。
鏈接辨別標籤可以有字母、數字、空白和標點符號,但是並不區分大小寫,因此下面兩個鏈接是一樣的:
[link text][a]
[link text][A]
隱式鏈接標記功能讓你可以省略指定鏈接標記,這種情形下,鏈接標記會視爲等同於鏈接文字,要用隱式鏈接標記只要在鏈接文字後面加上一個空的方括號,如果你要讓 “Google” 鏈接到 google.com,你可以簡化成:
[Google][]
然後定義鏈接內容:
[Google]: http://google.com/
由於鏈接文字可能包含空白,所以這種簡化型的標記內也許包含多個單詞:
Visit [Daring Fireball][] for more information.
然後接着定義鏈接:
[Daring Fireball]: http://daringfireball.net/
鏈接的定義可以放在文件中的任何一個地方,我比較偏好直接放在鏈接出現段落的後面,你也可以把它放在文件最後面,就像是註解一樣。
下面是一個參考式鏈接的範例:
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"
如果改成用鏈接名稱的方式寫:
I get 10 times more traffic from [Google][] than from
[Yahoo][] or [MSN][].
[google]: http://google.com/ "Google"
[yahoo]: http://search.yahoo.com/ "Yahoo Search"
[msn]: http://search.msn.com/ "MSN Search"
上面兩種寫法都會產生下面的 HTML。
<p>I get 10 times more traffic from <a href="http://google.com/"
title="Google">Google</a> than from
<a href="http://search.yahoo.com/" title="Yahoo Search">Yahoo</a>
or <a href="http://search.msn.com/" title="MSN Search">MSN</a>.</p>
下面是用行內式寫的同樣一段內容的 Markdown 文件,提供作爲比較之用:
I get 10 times more traffic from [Google](http://google.com/ "Google")
than from [Yahoo](http://search.yahoo.com/ "Yahoo Search") or
[MSN](http://search.msn.com/ "MSN Search").
參考式的鏈接其實重點不在於它比較好寫,而是它比較好讀,比較一下上面的範例,使用參考式的文章本身只有 81 個字符,但是用行內形式的卻會增加到 176 個字元,如果是用純 HTML 格式來寫,會有 234 個字元,在 HTML 格式中,標籤比文本還要多。
使用 Markdown 的參考式鏈接,可以讓文件更像是瀏覽器最後產生的結果,讓你可以把一些標記相關的元數據移到段落文字之外,你就可以增加鏈接而不讓文章的閱讀感覺被打斷。
反斜槓
Markdown 可以利用反斜槓來插入一些在語法中有其它意義的符號,例如:如果你想要用星號加在文字旁邊的方式來做出強調效果(但不用 <em>
標籤),你可以在星號的前面加上反斜槓:
\*literal asterisks\*
Markdown 支持以下這些符號前面加上反斜槓來幫助插入普通的符號:
\ 反斜線
` 反引號
* 星號
_ 底線
{} 花括號
[] 方括號
() 括弧
# 井字號
+ 加號
- 減號
. 英文句點
! 驚歎號