Markdown 語法完整指南

Markdown 語法完整指南

連結

行內連結

最常用的是行內寫法:方括號放連結文字,圓括號放網址。

[線上編輯器](https://mdeditor.tw/)

相對路徑的寫法完全相同([使用指南](/markdown-guide)),同頁錨點也是([見下文](#images))。

兩個常見錯誤要注意。網址裡的空格會讓連結斷掉,請改寫成 %20 或把整個網址用角括號包起來;新手也常把方括號和圓括號的順序寫反,開著預覽窗格就會當下現形。連結語法專頁還談到錨點、相對路徑與怎麼寫連結文字。

加上標題文字

網址後面可以再加一段用引號包住的標題,滑鼠停留時會顯示:

[線上編輯器](https://mdeditor.tw/ "免費線上 Markdown 編輯器")

標題很容易被濫用。它在觸控裝置上根本看不到,多數螢幕閱讀器也會略過,更不能拿來取代「本身就說清楚要連去哪裡」的連結文字。請只在真的有額外資訊要補充時才用。

參考式連結

當同一個網址在文件裡重複出現,或冗長的網址讓內文難以閱讀時,改用參考式連結:內文裡只寫簡短的標籤,網址在文件任何地方定義一次即可,慣例是放在文末。

[使用指南][docs] 和 [常見問題][docs] 都有說明。

[docs]: https://example.com/documentation "專案文件"

兩種寫法的渲染結果一模一樣,差別只在原始檔的整潔度。標籤不分大小寫;第二對方括號留空的話,連結文字本身就會當成標籤,例如 [docs][]。

定義那幾行不會出現在輸出裡。如果標籤沒定義,它會原樣顯示成方括號文字,那就是你打錯字的線索。

自動連結

想讓一個網址原樣顯示又能點擊,用角括號包住即可,例如 ,電子郵件位址也適用(<[email protected]>)。

而 GFM 更進一步,連角括號都不用,貼上網址就自動變成連結。這份方便在你不想要連結時就成了困擾:把網址用反引號包成程式碼,或把開頭的字元跳脫掉,就能維持純文字。

註腳

註腳把參考式的概念用在內文上:句子裡只放一個小標記,內容定義在檔案其他地方。要放標記的位置寫 [^1],再另起一行定義它:

Markdown 於 2004 年發表。[^1]

[^1]: 由 John Gruber 設計,Aaron Swartz 也參與了討論。

渲染器會把所有定義收集到頁面底部的註腳區,並自動補上回到標記的連結。編號一律依正文出現的順序自動產生,和你寫的標籤無關,所以 [^pricing-note] 和 [^2005-revision] 一樣會輸出成 1、2、3。

用有意義的名稱當標籤比用數字好維護:在草稿中間插入新註腳時,其他註腳都不必手動重編號。

麻煩的是相容性。註腳既不在原始 Markdown 規格裡,也不在 CommonMark 裡,它是一項擴充語法。GitHub、GitLab、Obsidian 與 Pandoc 都能渲染;Reddit、Discord 和純 CommonMark 解析器則會忽略它,把方括號原樣印出來。註腳完整說明另外整理了多段落註腳的寫法、各平台支援對照表與不支援時的替代做法。

相关推荐

平板安卓office365破解版 ps如何恢复初始设置

ps如何恢复初始设置

📅 10-16 👁️ 3200
平板安卓office365破解版 我是卖家,买家付款后我要在多久内发货?

我是卖家,买家付款后我要在多久内发货?

📅 10-03 👁️ 4770