什麼是 Markdown?

Markdown 是一種輕量級標記語言,讓你用簡單的純文字語法來撰寫格式化文件。它由 John Gruber 於 2004 年創建,目標是讓文件在原始碼狀態下也能輕鬆閱讀。

為什麼要使用 Markdown?

  • 簡潔易學:語法直覺,幾分鐘就能上手
  • 廣泛支援:GitHub、GitLab、Notion、HackMD、VS Code 等工具都支援
  • 專注內容:不需要滑鼠點按格式按鈕,雙手不離鍵盤就能完成排版
  • 版本控制友好:純文字格式,非常適合搭配 Git 使用
  • 多格式輸出:可以輕鬆轉換成 HTML、PDF、簡報等格式

Markdown 常見用途

  • 撰寫技術文件與 README
  • 部落格文章
  • 筆記與知識管理
  • GitHub Issues 與 Pull Request 描述
  • 電子郵件與訊息格式化

標題 (Headings)

使用 # 符號來建立標題,# 的數量代表標題層級(1-6 級):

Loading...

提示# 與標題文字之間需要一個空格。一般建議文件中只使用一個 H1 標題,其餘使用 H2 以下。


段落與換行 (Paragraphs & Line Breaks)

段落之間需要一個空行來分隔:

Loading...

如果只需要換行而不是新段落,可以在行尾加上兩個空格後按 Enter,或使用 <br> 標籤:

Loading...

文字強調 (Text Emphasis)

粗體 (Bold)

Loading...

這是粗體文字

斜體 (Italic)

Loading...

這是斜體文字

粗體加斜體 (Bold & Italic)

Loading...

這是粗體加斜體

刪除線 (Strikethrough)

Loading...

這是被刪除的文字

醒目標記 (Highlight)

部分平台支援使用 == 來標記重點文字:

Loading...

列表 (Lists)

無序列表 (Unordered List)

使用 -*+ 來建立無序列表:

Loading...
  • 項目 1
    • 子項目 1.1
    • 子項目 1.2
  • 項目 2
    • 子項目 2.1
      • 子子項目 2.1.1

有序列表 (Ordered List)

使用數字加上 . 來建立有序列表:

Loading...
  1. 第一項
  2. 第二項
    1. 第二項的子項 1
    2. 第二項的子項 2
  3. 第三項

提示:有序列表的數字不需要按順序,Markdown 會自動編號。但建議還是按順序撰寫以提高原始碼的可讀性。


引用 (Blockquote)

使用 > 來建立引用區塊:

Loading...

這是一個引用。

這是嵌套的引用。

引用區塊中也可以包含其他 Markdown 元素:

注意:引用中可以使用粗體斜體程式碼等格式。

  • 也可以包含列表
  • 非常實用

程式碼 (Code)

單行程式碼 (Inline Code)

使用反引號 ` 包裹程式碼:

Loading...

使用 console.log() 來輸出訊息。

多行程式碼區塊 (Code Blocks)

使用三個反引號 ``` 並指定語言來建立程式碼區塊:

Loading...
Loading...

常用的語言標示:javascriptpythonbashhtmlcssjsonyamlsqlgorust 等。

差異對比 (Diff)

使用 diff 語言標示可以顯示程式碼變更:

Loading...
Loading...

Loading...

連結文字

適合在文件中多次使用同一個連結:

Loading...

直接貼上 URL 或使用角括號:

Loading...

圖片 (Images)

Loading...

替代文字

也可以使用參考連結的方式:

Loading...

提示:如果需要控制圖片大小,可以使用 HTML 的 <img> 標籤:

Loading...

表格 (Tables)

使用 |- 來建立表格:

Loading...
標題 1標題 2標題 3
單元格 1單元格 2單元格 3
單元格 4單元格 5單元格 6

表格對齊 (Alignment)

使用 : 來控制對齊方式:

Loading...
靠左對齊置中對齊靠右對齊
資料資料資料

任務列表 (Task Lists)

使用 - [ ]- [x] 建立任務列表:

Loading...
  • 已完成項目
  • 這個也完成了
  • 尚未完成的項目
  • 待辦事項

分隔線 (Horizontal Rule)

使用三個或以上的 -*_ 來建立分隔線:

Loading...

跳脫字元 (Escaping Characters)

要顯示 Markdown 的特殊符號,可以用反斜槓 \ 來跳脫:

Loading...

可跳脫的字元:\`*_{}[]()#+-.!|


注腳 (Footnotes)

注腳可以為內容添加補充說明,而不影響正文的閱讀流暢度:

Loading...

這是一段文字,附有注腳。1


折疊區塊 (Collapsible Sections)

使用 HTML 的 <details> 標籤來建立可折疊的內容區塊:

Loading...
<details> <summary>點擊展開</summary>

這裡是被折疊的內容。

</details>

數學公式 (Math Equations)

部分平台(如 GitHub、HackMD)支援 LaTeX 數學公式:

行內公式

Loading...

行內公式:$E = mc^2$

獨立公式區塊

Loading...

$$ \sum_{i=1}^{n} x_i = x_1 + x_2 + \cdots + x_n $$


自訂 HTML (Custom HTML)

Markdown 中可以直接嵌入 HTML 標籤,用於實現 Markdown 語法無法達成的排版效果:

Loading...

GitHub 特殊語法 (GitHub Flavored Markdown)

GitHub 支援一些額外的 Markdown 語法:

提醒區塊 (Alerts)

Loading...

表情符號 (Emoji)

Loading...

提及與參照 (Mentions & References)

Loading...

最佳實踐

  • 保持一致性:選定一種風格後(例如用 - 還是 * 作為列表符號),全文保持一致
  • 善用空行:段落之間、標題前後加上空行,讓原始碼更易讀
  • 使用標題建立結構:合理使用 H2-H4 標題,讓文件有清晰的層次結構
  • 替代文字:圖片一定要加上替代文字,提升無障礙性
  • 預覽確認:撰寫後使用預覽功能確認排版效果
  • 善用程式碼區塊:指定語言以獲得語法高亮,提升可讀性

Footnotes

  1. 這是注腳的內容。