3分鐘學會Markdown常用語法

3分鐘學會Markdown常用語法


概述

HTML與Markdown,兩者是相輔相成,HTML就像是稿紙上的格線,規劃整體的格式;而Markdown就是裡面的標點符號,讓文件容易閱讀及編寫。因此,Markdown的語法全由標點符號組成。「易讀易寫」就是Markdown的精神。

HTML 是一種發佈的格式,Markdown是一種編寫的格式,使用Markdown格式撰寫的文件應該可以直接以純文字發佈,並且看起來不會像是由許多標籤或是格式指令所構成。

Markdown的語法有個主要的目的:用來作為一種網路內容的寫作用語言。
不在Markdown涵蓋範圍之外的標籤,都可以直接在文件裡面用HTML撰寫。


編輯工具Bear

如果是MAC的使用者,推薦用Bear - Notes for iPhone, iPad and Mac這套軟體來用Markdown語法寫文件,以下介紹Bear的格式功能:

標題

Markdown支援兩種標題的語法,Setext和atx形式。
Setext形式是用底線的形式,利用=(最高階標題)和-(第二階標題)
Atx形式則是在行首插入1到6個 # ,各對應到標題1到6階,例如:

1
2
3
# This is an H1
## This is an H2
###### This is an H6

行分隔符

你可以在一行中用三個或以上的星號、底線、減號來建立一個分隔線,行內不能有其他東西。例如:

1
2
3
***
_______
-------------------

插入連結

粗體、斜體、底線、刪除線是基本的屬性,這邊另外介紹插入連結

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

要建立一個行內形式的連結,只要在方塊括號後面馬上接著括號並插入網址連結即可,如果你還想要加上連結的title文字,只要在網址後面,用雙引號把title文字包起來即可,

例如:
[Markdown 語法說明](http://markdown.tw/ "Title")

結果:
Markdown 語法說明

自動連結

Markdown支援比較簡短的自動連結形式來處理網址和電子郵件信箱,只要是用角括號包起來,Markdown就會自動把它轉成連結,連結的文字就和連結位置一樣

例如:
<http://markdown.tw/>

結果:
http://markdown.tw/


清單

Markdown支援有序清單和無序清單。

無序清單使用星號、加號或是減號作為清單標記:

1
2
3
* 星號
+ 加號
- 減號

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

1
2
1. 有序
2. 清單

順帶一提,行首出現數字-句點-空白,要避免這樣的狀況,你可以在句點前面加上反斜線。

例如:
1986\. What a great season.

結果:
1986. What a great season.

引用

Markdown使用email形式的區塊引言,看起來像是你強迫斷行,然後在每行的最前面加上 >

例如:
> one today is worth two tomorrows

結果:

one today is worth two tomorrows

待辦事項

待辦事項是相當實用的功能,方便記錄各種事項,只要在每行最前面加上 - [ ]

例如:

1
2
- [ ] 待辦事項
- [x] 已完成事項

結果:

  • 待辦事項
  • 已完成事項

程式碼

要標記一小段行內程式碼,可以用反引號把它包起來(`)

範例:
Use the printf() function.

而要標記多行程式碼,則使用3個反引號包起來

範例:

1
2
s = "Python syntax highlighting"
print s

圖片

Markdown使用一種和連結很相似的語法來標記圖片,使用方法為如下:

一個驚嘆號!
接著一個方括號,裡面放上圖片的替代文字
接著一個普通括號,裡面放上圖片的網址,最後還可以用引號包住並加上 選擇性的’title’文字。

行內圖片的語法看起來像是:
![Alt text](/path/to/img.jpg "Optional title")


參考資料

Markdown | GitBook 中文解說 - 2.4
Markdown 語法說明