Markdown 語法速查

預覽使用 marked.js 解析,支援 GitHub Flavored Markdown(GFM)。 下面每一段的寫法都可以直接複製到編輯器裡試。

本頁目錄

上面這份目錄是手打在檔案最前面的,不是編輯器自動生成的功能 —— 每一行都是一個連到本頁某個標題的連結,寫法見目錄與錨點。

標題

# 一級標題
## 二級標題
### 三級標題

標題會自動取得錨點 id,所以文件裡任何一段都可以連到它 —— 目錄就是這樣做出來的,見目錄與錨點。

強調

**粗體** *斜體* ~~刪除線~~ `行內程式碼`
<u>底線</u>

Markdown 沒有底線語法,工具列的「底線」按鈕插入的是 HTML 的 <u> 標籤。 其他 Markdown 工具不一定支援它 —— 如果這份文件之後要餵給別的產生器,底線要小心用。

清單

- 項目
- 項目
  - 巢狀項目(縮排兩格)

1. 有序項目
2. 有序項目

- [x] 已完成的待辦
- [ ] 還沒做的待辦

連結與圖片

[顯示文字](https://example.com)
![替代文字](images/screenshot.png)

圖片路徑相對於文件所在的資料夾。因為預覽是在瀏覽器裡跑的,本機圖片只有在瀏覽器拿得到那個路徑時才顯示得出來; 比較保險的做法是用完整網址,或把圖片放在同一層資料夾。

目錄與錨點

每個標題都會自動拿到一個錨點 id,所以文件裡任何地方都能用 [文字](#id) 跳過去。 把這種連結排成一份清單放在檔案最前面,就是一份可以點的目錄 —— 長文件不必再往下捲著找段落:

[安裝步驟](#安裝步驟)
[常見問題](#常見問題)

## 安裝步驟
## 常見問題

id 就是標題文字本身,照三條規則換算:

規則標題要寫的連結
英文一律轉小寫## Quick Start#quick-start
空白換成連字號## 第 2 章#第-2-章
標點整個消失## 資料存在哪裡?可以清掉嗎?#資料存在哪裡可以清掉嗎

中文與日文標題可以直接當 id 用,不必轉成拼音或另外編號。

⚠️ 第三條最容易寫錯:中文標題裡的 、:?, 是整個不見,不是變成連字號。 所以 ## 為什麼只有 Chrome、Edge 可以 的 id 是 #為什麼只有-chromeedge-可以 —— 中間那三個字黏在一起。 不想每次都算,最省事的做法是標題裡不要放標點。

同一份文件出現兩個一模一樣的標題時,第二個以後會自動加編號:#重點、#重點-1、#重點-2。

這一套規則跟 GitHub 相同,所以同一份 .md 傳到 GitHub 上,目錄一樣跳得到。 點目錄時網址列不會被塞一堆 #,回上一頁也不會變成在同一頁裡跳來跳去。

引言與分隔線

> 引言可以連續好幾行,
> 每一行都加上大於符號。

---

表格

| 欄位 | 說明 | 數量 |
| --- | :---: | ---: |
| 左對齊 | 置中 | 右對齊 |
| a | b | 3 |

分隔列的冒號決定對齊::--- 左、:---: 置中、---: 右。 工具列的「表格」按鈕會問你要幾欄,然後把表頭與分隔列一次插入。

程式區塊

在程式碼前後各放一行三個反引號,開頭那行可以加語言名稱:

```js
const answer = 42;
```

預覽裡每個程式區塊的右上角都會出現複製按鈕,按一下整段進剪貼簿。

換行

Markdown 的單一換行不會變成換行。要換行有兩種寫法:

行尾留兩個空白後換行  
這樣就會斷行

或者中間空一整行,
變成兩個段落。

用 HTML 補 Markdown 沒有的語法

Markdown 本身沒有底線、螢光筆與註解。這個編輯器的預覽原樣支援 HTML, 所以下面這些都能用(每一項都在這個編輯器裡實際測過):

<u>底線</u>
<mark>螢光筆標記</mark>
按 <kbd>Ctrl</kbd>+<kbd>S</kbd> 存檔
H<sub>2</sub>O 與 x<sup>2</sup>

註解:寫給自己看、不會出現在預覽

用 HTML 註解包起來的內容不會顯示在預覽裡,但會留在 .md 原始檔中。 這是 Markdown 唯一通用的註解寫法 —— 沒有 // 或 # 那種語法。

<!-- 這段只有打開原始碼才看得到 -->

這句話有 <!-- 隱藏的備註 --> 註解,讀者只會看到前後文。

整段跟行內都可以,也可以跨多行。要暫時「關掉」一段內容而不刪除它,這是最省事的做法。

摺疊區塊

<details><summary>點開看更多</summary>

藏在裡面的內容。**Markdown 語法在這裡照樣有效**,但前後要各空一行。

</details>

⚠️ 這些都是 HTML,不是 Markdown。 在這個編輯器裡沒問題,但這份 .md 之後如果要餵給 別的產生器(靜態網站、部落格平台、GitHub),對方不一定支援,甚至可能整段被過濾掉。 只在自己的文件裡用,或先確認目標平台吃不吃。

⚠️ 預覽對 HTML 不做任何過濾,寫什麼就渲染什麼。你編輯的是自己硬碟上的檔案, 所以這是刻意的行為(保留 HTML 的完整能力)—— 但不要把來路不明的 HTML 貼進來預覽。

這個編輯器多做的一件事

檔案最前面的 YAML front matter 不會被當成分隔線或標題吃掉,而是渲染成一張獨立的卡片 —— 細節見YAML front matter。

下載這一頁的 .md 原始檔 用編輯器打開它,就是一份現成的範例文件。

← 回手冊目錄