創用 CC 授權條款
除非另有註明,本網站的著作Fygul Hether製作,以創用CC 姓名標示-非商業性-禁止改作 4.0 國際 授權條款釋出。

2017年12月1日 星期五

常用Markdown語法

記錄自己慣用的Markdown語法。有些語法有多種寫法,這裡只記錄較主要的寫法。較詳盡的可見〈Markdown簡介與資源列表〉中所列的連結。

標題

  • # 開頭,1到6個#符號表標題1至6。

段落與換行

  • 空白行即可區隔段落。

水平分隔線

  • 單獨一行使用---或___或***,3個或以上符號,前後不可有其他文字。

強調

  • *斜體*
  • _斜體_
  • **粗體**
  • __粗體__
  • ~~刪除~~
  • _可以**結合**使用_

清單

無序

  • 以*, +或-與一空白開頭,可替換使用,子層可用2個空白做縮排。

有序

  • 使用阿拉伯數字,隨後半形句號與一空白做開頭。

連結

  • 連結可指到相對路徑、錨點或絕對路徑。除了URL與<URL>會被自動轉成連結,還有二種表示型式:

inline

  • 這是一個[範例](http://example.com/ "標題"),帶有標題的行內連結。
  • 標題屬性不是必要的。

參考

  • 這是一個參考型式的連結[範例][id]。
    之後,在文件的任何地方,像這樣定義連結標籤:
    [id]: http://example.com/ "選項的標題"
    此id可用文字,也可用數字
  • 另一種作法是使用[文字本身]
    同樣,在文件某處定義連結:
    [文字本身]: http://somewhere.com

圖片

  • 與連結相似,同樣有inline與參考二種型式,但在前面多加個!:
    一張![圖片](img/image.jpg)

引用

  • 連續幾行以>與一選項的空白做開頭的文字。很長的一行文字在折行後也可行,在其中同樣可用Markdown。

表格

| 標頭1 | 標頭2 |
| --- | --- |
| 內容1 | 內容2 |
| 內容3 | 內容 4 |
  • 在標頭列下的水平分隔中所用的 - 至少要有3個。
  • 表格左右兩端的 | 是選項的。
  • :用來標示對齊(放左邊即左邊對齊;放右即右對齊,二邊都擺即置中。

代碼

參雜寫在文字行中的代碼,可用 ` 符號包夾,像:`$ echo 'Hello World!'`。

整段的代碼,則有二種不同代碼區塊型式。一種使用4空白做行縮排;另一種使用```做為分界符,其內容不需縮排,且可清楚標示語言名稱:
  • ```python
    s = "Python syntax highlighting"
    print(s)
    ```
  • 支援的語言與標示名稱可參考highlight.js的 Supported Languages頁,其中的Language與Classes欄。
  • 如果```後沒有指定語言,就不會有語法高亮。
語法高亮標示並非Markdown規格的一部分,這類功能的實作還有些分歧,這裡就不深談。 

忽略Markdown格式

  • 在Markdown字元前使用跳脫字元 \

參考

  • https://wastemobile.gitbooks.io/gitbook-chinese/format/markdown.html
Update: 2020-6-7

沒有留言:

張貼留言