人生就是不斷學習,調整與更新持續前進。

AI工作流之 MD檔案格式與語法

Markdown 語法完整參考手冊

一份涵蓋所有常用語法的速查文件,包含標準 MD、GFM(GitHub Flavored Markdown)與進階技巧。

 


1. 標題

使用 # 號,# 數量代表層級(1–6 級)。

# H1 最大標題
## H2 二級標題
### H3 三級標題
#### H4 四級標題
##### H5 五級標題
###### H6 最小標題

另一種 H1 / H2 寫法(Setext 風格):

H1 標題
=======

H2 標題
-------

慣例# 後面加一個空格;標題前後各留一空行。


2. 段落與換行

段落

段落之間用空行分隔。

這是第一段。

這是第二段。

換行(Soft Break)

行尾加兩個空格\,再按 Enter:

第一行(行尾兩個空格)  
第二行

第一行\
第二行

強制不斷行

使用 HTML   或連接字元避免自動換行。


3. 文字樣式

效果 語法 結果 粗體 **文字**__文字__ 文字 斜體 *文字*_文字_ 文字 粗斜體 ***文字*** 文字 刪除線 ~~文字~~ ~~文字~~ 行內程式碼 `程式碼` 程式碼 底線(HTML) <u>文字</u> <u>文字</u> 上標(HTML) X<sup>2</sup> X<sup>2</sup> 下標(HTML) H<sub>2</sub>O H<sub>2</sub>O 標記(HTML) <mark>高亮</mark> <mark>高亮</mark>
**粗體**  __也是粗體__
*斜體*    _也是斜體_
***粗斜體***
~~刪除線~~
`行內程式碼`

4. 引用區塊

基本引用

> 這是一段引用文字。

多行引用

> 第一行
> 第二行
> 第三行

巢狀引用

> 外層引用
>
>> 內層引用
>>
>>> 更深一層

引用內使用其他語法

> ### 引用內的標題
>
> - 清單項目
> - 另一個項目
>
> **粗體文字** 也可以在引用裡使用。

提示區塊(Callout,部分平台支援)

> [!NOTE]
> 這是一般提示。

> [!TIP]
> 這是小技巧。

> [!IMPORTANT]
> 這是重要資訊。

> [!WARNING]
> 這是警告。

> [!CAUTION]
> 這是危險警告。

5. 列表

無序清單

使用 -*+(可混用,但建議統一):

- 項目一
- 項目二
  - 子項目(縮排 2 個空格)
  - 子項目
    - 更深層(縮排 4 個空格)
- 項目三

有序清單

1. 第一項
2. 第二項
   1. 子項目(縮排 3 個空格)
   2. 子項目
3. 第三項

✅ 數字可以全部寫 1.,渲染時會自動編號:

1. 第一項
1. 第二項
1. 第三項

清單中插入段落或程式碼

1. 第一項

   這是屬於第一項的段落(縮排對齊)。

2. 第二項

   ```python
   print("屬於第二項的程式碼區塊")
  1. 第三項

### 定義清單(部分平台支援)

```markdown
術語一
: 定義內容

術語二
: 定義內容一
: 定義內容二

6. 程式碼

行內程式碼

使用 `console.log()` 印出結果。

程式碼區塊(Fenced Code Block)

用三個反引號包住,並指定語言:

```python
def hello(name: str) -> str:
    return f"Hello, {name}!"
```

常用語言識別字

語言 識別字 JavaScript jsjavascript TypeScript tstypescript Python pythonpy Bash / Shell bashsh SQL sql HTML html CSS css JSON json YAML yamlyml Markdown markdownmd Java java Go go Rust rust C / C++ c / cpp 純文字 textplain 差異對比 diff

Diff 差異標示

```diff
- 這行被刪除(紅色)
+ 這行被新增(綠色)
  這行沒有變化
```

在程式碼區塊內顯示反引號

用四個反引號包住三個反引號的區塊:

````markdown
```這裡可以顯示三個反引號```
````

7. 連結

行內連結

[顯示文字](https://example.com)

[顯示文字](https://example.com "滑鼠懸停提示")

參考式連結

[顯示文字][ref-id]

[ref-id]: https://example.com "選填的提示文字"

自動連結

<https://example.com>
<[email protected]>

頁內錨點連結

跳至 [第三節](#3-文字樣式)

<!-- 規則:標題轉小寫,空格換成 -,移除特殊字元 -->

相對路徑連結

[查看 README](./README.md)
[查看圖片](../images/photo.png)

8. 圖片

基本語法

![替代文字](圖片網址)

![替代文字](圖片網址 "提示文字")

參考式圖片

![替代文字][img-id]

[img-id]: /path/to/image.png "提示文字"

可點擊的圖片(連結包圖片)

[![替代文字](圖片網址)](點擊後跳轉的連結)

控制圖片尺寸(HTML)

<img src="image.png" alt="說明" width="300" height="200">
<img src="image.png" alt="說明" width="50%">

圖片置中(HTML)

<p align="center">
  <img src="image.png" alt="說明" width="400">
</p>

9. 表格

基本語法

| 欄位一 | 欄位二 | 欄位三 |
|--------|--------|--------|
| 資料 A | 資料 B | 資料 C |
| 資料 D | 資料 E | 資料 F |

對齊方式

| 靠左對齊 | 置中對齊 | 靠右對齊 |
|:---------|:--------:|---------:|
| 文字     |   文字   |     文字 |
| 數字     |   數字   |     1234 |

說明:

表格內使用樣式

| 功能     | 說明                  |
|----------|-----------------------|
| **粗體** | 表格內支援行內樣式    |
| `程式碼` | 也支援行內程式碼      |
| [連結](https://example.com) | 和連結 |

⚠️ 表格不支援多行內容;若需要,改用 HTML <table>


10. 分隔線

以下三種寫法效果相同(三個或更多):

---

***

___

✅ 建議使用 ---,且前後各留一空行,避免被誤判為標題語法。


11. 任務清單

(GitHub Flavored Markdown 支援)

- [x] 已完成的任務
- [ ] 未完成的任務
- [x] 另一個已完成的任務
  - [ ] 子任務(縮排支援)
  - [x] 已完成的子任務

渲染效果:


12. 腳註

這段文字需要補充說明[^1],另一個地方也需要[^note]。

[^1]: 這是第一個腳註的內容。

[^note]: 這是具名腳註,內容可以很長,
    縮排後繼續延伸。

13. 跳脫字元

在特殊字元前加 \ 使其顯示為原始字元:

\*不是斜體\*
\# 不是標題
\[不是連結\]
\`不是程式碼\`

可跳脫的特殊字元:

\ ` * _ { } [ ] ( ) # + - . ! |

14. HTML 嵌入

Markdown 支援直接嵌入 HTML(部分平台會過濾):

常用 HTML 元素

<!-- 換行 -->
<br>

<!-- 分隔線 -->
<hr>

<!-- 可折疊區塊 -->
<details>
  <summary>點擊展開</summary>
  
  這裡是隱藏的內容。
  
  支援 **Markdown** 語法(需要空行)。
</details>

<!-- 顏色文字(部分平台支援) -->
<span style="color: red;">紅色文字</span>

<!-- 置中 -->
<div align="center">置中的內容</div>

<!-- 鍵盤按鍵樣式 -->
按下 <kbd>Ctrl</kbd> + <kbd>C</kbd> 複製

15. Emoji

語法一:Emoji 代碼(部分平台)

:smile:   😄
:heart:   ❤️
:rocket:  🚀
:warning: ⚠️
:check:   ✅
:x:       ❌
:bulb:    💡
:fire:    🔥
:star:    ⭐
:zap:     ⚡

語法二:直接貼上 Unicode Emoji

✅ 成功
❌ 失敗
⚠️ 警告
💡 提示
🚀 部署
🔧 設定
📝 文件
📦 套件

16. 數學公式

(需平台支援 KaTeX 或 MathJax)

行內公式

質能等價公式:$E = mc^2$

區塊公式

$$
\int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi}
$$

常用符號

上標:x^{2}
下標:x_{i}
分數:\frac{a}{b}
根號:\sqrt{x}
總和:\sum_{i=1}^{n}
積分:\int_{a}^{b}
希臘字母:\alpha \beta \gamma \delta \pi \sigma

17. Mermaid 圖表

(GitHub、Notion 等平台支援)

流程圖

```mermaid
flowchart TD
    A[開始] --> B{判斷條件}
    B -- Yes --> C[執行動作 A]
    B -- No --> D[執行動作 B]
    C --> E[結束]
    D --> E
```

時序圖

```mermaid
sequenceDiagram
    participant 用戶
    participant 前端
    participant 後端
    participant 資料庫

    用戶->>前端: 送出表單
    前端->>後端: POST /api/login
    後端->>資料庫: 查詢用戶
    資料庫-->>後端: 回傳資料
    後端-->>前端: JWT Token
    前端-->>用戶: 登入成功
```

甘特圖

```mermaid
gantt
    title 專案時程
    dateFormat  YYYY-MM-DD
    section 第一階段
    需求分析     :a1, 2024-01-01, 7d
    設計規格     :a2, after a1, 7d
    section 第二階段
    前端開發     :b1, after a2, 14d
    後端開發     :b2, after a2, 14d
```

ER 圖

```mermaid
erDiagram
    USER {
        uuid id PK
        string email
        string name
    }
    POST {
        uuid id PK
        string title
        uuid user_id FK
    }
    USER ||--o{ POST : "撰寫"
```

狀態圖

```mermaid
stateDiagram-v2
    [*] --> 草稿
    草稿 --> 審核中 : 提交
    審核中 --> 已發布 : 核准
    審核中 --> 草稿 : 退回修改
    已發布 --> [*]
```

18. 常用符號速查表

文件結構符號

符號 用途 --- 分隔線 / Front Matter 邊界 > 引用 # 標題 - / * / + 無序清單 1. 有序清單 - [ ] 任務清單 [^id] 腳註

格式符號

語法 效果 **text** 粗體 *text* 斜體 ~~text~~ ~~刪除線~~ `text` 行內程式碼 [text](url) 超連結 ![alt](url) 圖片

排版技巧速查

<!-- 強制空行(不被 Markdown 壓縮) -->
&nbsp;

<!-- 不換行空格 -->
A&nbsp;B

<!-- 水平置中圖片 -->
<p align="center"><img src="..." width="300"></p>

<!-- 可折疊內容 -->
<details><summary>標題</summary>內容</details>

<!-- 鍵盤按鍵 -->
<kbd>Enter</kbd>

<!-- 高亮文字 -->
<mark>重點</mark>

附錄:平台支援對照

語法 標準 MD GitHub Notion Obsidian VS Code 標題/粗體/斜體 ✅ ✅ ✅ ✅ ✅ 表格 ❌ ✅ ✅ ✅ ✅ 任務清單 ❌ ✅ ✅ ✅ ✅ 腳註 ❌ ✅ ❌ ✅ ✅ Mermaid 圖表 ❌ ✅ ✅ ✅ ✅(需外掛) 數學公式 ❌ ✅ ✅ ✅ ✅(需外掛) Callout [!NOTE] ❌ ✅ ❌ ✅ ❌ HTML 嵌入 ✅ ✅(部分) ❌ ✅ ✅

本文件涵蓋 CommonMark、GFM(GitHub Flavored Markdown)及常用擴充語法。 建議搭配 CommonMark Spec 查閱完整規範。