# GitHub Alert(提示區塊)說明
GitHub Flavored Markdown 的 **alert** 語法,用 `> [!類型]` 開頭,內容接在後續的 `>` 行。
適合在文件中標示「補充說明、風險、警告」等需要醒目的內容。
## 五種類型
> [!NOTE]
> 補充說明、背景資訊。藍色。
> [!TIP]
> 建議做法、小技巧。綠色。
> [!IMPORTANT]
> 必須知道的重要資訊。紫色。
> [!WARNING]
> 需要注意的風險或限制。橘色。
> [!CAUTION]
> 可能造成損害的操作警告。紅色。
## 語法
```markdown
> [!WARNING]
> 第一行內容
>
> 第二段內容(段落之間用單獨一行 `>`)
>
> - 也可以放清單
> - 或 `code`、**粗體**、[連結](https://example.com)
```
規則:
- `[!類型]` 必須是引用區塊的**第一行**,類型大小寫不拘(`note` / `NOTE` 皆可)。
- 標記本身可留白:`> [!WARNING] `(尾端空白不影響)。
- 內容支援一般 Markdown(清單、程式碼、粗體、連結、多段落)。
- 不是這五種類型的 `> [!XXX]` 會退回一般引用區塊樣式。
## 渲染支援
| 環境 | 行為 |
| ------ | ------ |
| GitHub(README、Docs) | 原生渲染成對應顏色 |
| 本專案變更歷史 GUI(`Scripts/change_log.py`) | 支援相同五種 alert 樣式 |
| 其他純 Markdown 檢視器 | 多數會當成普通引用區塊(仍可讀) |
## 本專案用途
`Docs/ChangeHistory.md` 的條目中用它標示**已知風險或限制**。例如「語音通話與直播共存」條目裡的音訊管線警告,
就是提醒「該功能狀態未定、可能沒聲音、請避免啟用遊戲內語音通話」。