Markdown 一頁看完。你輸入什麼,就得到什麼。
Markdown 是帶有少數標記來表示格式的純文字。本頁列出你會用到的標記,並說明輸入的內容與顯示的結果。
需要 macOS 14 或以上版本。閱讀免費;編輯與審閱為一次付費。
快速解答
Markdown 是帶有少數標記的純文字:# 表示標題、- 表示清單、**bold**、`code`、[link](url)、| a | b | 表示表格、- [ ] 表示待辦事項。本頁列出每個元素,附上輸入的內容與顯示的結果,也包括 GitHub 的擴充:表格、待辦清單、標註、Mermaid 圖表與數學公式。
標題、文字與換行
| 你輸入 | 你得到 |
|---|---|
# Heading 1 到 ###### Heading 6 | 標題,由最大到最小。# 後面要加一個空格。 |
**bold** | 粗體 |
*italic* 或 _italic_ | 斜體 |
~~strikethrough~~ | |
> a quote | 縮排的引用。引用可以用 > > 巢狀嵌套。 |
單獨一行的 --- | 水平線。上方要留一個空行。 |
\*not italic\* | 反斜線會讓符號照原樣顯示。 |
空行會開始新的段落。段落內單一的換行會被忽略,各行會接在一起。若要強制換行,請在行尾加兩個空格或一個反斜線。
清單、待辦清單與表格
- Milk
- Bread
- Rye
- Wheat
1. Open the folder
2. Pick a file
- [x] Write the plan
- [ ] Review it
項目符號清單的每一行以 -、* 或 + 開頭。縮排兩個或四個空格即可巢狀嵌套。編號清單只需第一個數字正確。待辦清單是在前面加上 [ ] 或 [x] 的項目符號清單,會顯示為核取方塊。
| Plan | Price | Users |
|-------|------:|:-----:|
| Free | $0 | 1 |
| Team | $12 | 10 |
在表格中,第二行用來分隔表頭與資料列。:--- 讓該欄靠左對齊,---: 靠右,:---: 置中。文字中各欄不必對齊。若要在儲存格中放入 |,請寫成 \|。
程式碼
行內程式碼用單個反引號包住。程式碼區塊則在前一行與後一行各放三個反引號,並在開頭的反引號後寫上語言名稱,即可得到語法色彩:
```swift
let greeting = "Hello"
```
標記為 diff 的區塊會為以 + 和 - 開頭的行上色。標記為 mermaid 的區塊會變成圖表。
連結與圖片
[DotMD](https://getdotmd.com)

[the plan](plan.md)
[setup](#setup)
連結的文字放在方括號中,位址放在圓括號中。單獨一個網址也會變成連結。圖片是前面加了 ! 的連結;它的文字是給螢幕閱讀器的說明。路徑相對於文件,連結可以指向另一個 .md 檔案或某個標題,標題的錨點是它的文字轉成小寫、空格換成 -。
太長或重複出現的位址,可以放在底部,再用短名稱引用:[guide][1],然後在單獨一行寫 [1]: https://example.com/guide。
標註、註解與 front matter
> [!NOTE]
> Useful information that users should know.
第一行是 [!NOTE]、[!TIP]、[!IMPORTANT]、[!WARNING] 或 [!CAUTION] 的引用,會變成彩色方框,語法與 GitHub 相同。
- 不會顯示在頁面上的註解:
<!-- a note only visible in the text -->。 - 用 HTML 的
<details>與<summary>做可摺疊區塊,內部的 Markdown 前後要留空行。 - Front matter:位於檔案最前面幾行、夾在兩行
---之間的區塊,可放標題、標籤或狀態。DotMD 會在文件上方以 Properties 卡片顯示。
數學公式與圖表
GitHub 和 DotMD 都能繪製的兩項擴充。公式放在美元符號之間,$E = mc^2$,或獨占一行、放在雙美元符號之間:用 LaTeX 寫 Markdown 數學公式。圖表是標記為 mermaid 的程式碼區塊,圖表的文字寫在裡面:Mermaid 圖表。
試試看
學會這些標記最快的辦法,就是看它們渲染後的樣子。在 DotMD 開啟任何 .md 檔案,就能讀到格式化後的內容,表格、程式碼、標註、圖表與公式都會繪製出來。閱讀免費。在編輯器中,Insert 選單會替你輸入這些符號,所以你不需要記住這一切。