## 參考

GitHub Markdown 標註

發布於 2026 年 3 月

GitHub 為 GitHub Flavored Markdown 加入了標註（提醒）語法。這些有樣式的提示框可以在文件中突顯重要資訊 — 備註、提示、警告等。ShowMeMyMD 是少數能渲染這些標註的桌面檢視器之一。

## 語法

五種標註類型

標註使用區塊引用語法，在第一行加上特殊標記。格式始終相同： > [!TYPE] 接著在下一行寫上你的內容，同樣以 > 開頭。

> [!NOTE]
> Useful information that users should know,
> even when skimming content.

NOTE — 渲染為藍色資訊框。用於額外的背景資訊，有幫助但不關鍵。類似「順便一提」的資訊。

> [!TIP]
> Helpful advice for doing things better
> or more easily.

TIP — 渲染為綠色建議框。用於最佳實踐、捷徑或讓讀者更輕鬆的建議。

> [!IMPORTANT]
> Key information users need to know to
> achieve their goal.

IMPORTANT — 渲染為紫色強調框。用於在繼續之前必須了解的關鍵資訊。不是警告，但不能跳過。

> [!WARNING]
> Urgent info that needs immediate user
> attention to avoid problems.

WARNING — 渲染為黃色警告框。用於潛在問題、陷阱或讀者不注意就可能出錯的事項。

> [!CAUTION]
> Advises about risks or negative outcomes
> of certain actions.

CAUTION — 渲染為紅色危險框。保留給不可逆操作、資料遺失場景，或可能導致系統崩潰的操作。

## 使用技巧

太多標註會產生視覺噪音。如果所有東西都很重要，那就沒有東西是重要的。一整頁的彩色方框會讓讀者學會忽略它們。每個章節一到兩個通常是恰當的數量。

不要用 CAUTION 來標示一個小提示。不要用 NOTE 來標示可能刪除資料庫的事項。色彩編碼的存在是為了讓讀者即時判斷嚴重程度 — 請尊重它。

標註最適合一到三句話。如果你需要多個段落，那些資訊可能應該放在正文中，而不是標註框裡。

行內程式碼、連結、粗體和斜體在標註中都能正常使用。每一行都以 > 開頭，以保持內容在標註區塊內。

## 相容性

大多數 Markdown 檢視器只會顯示區塊引用。

ShowMeMyMD 渲染完整的有樣式標註 — 彩色側邊欄、圖示和正確的格式 — 就像在 GitHub 上看到的一樣。如果你撰寫帶有標註的 README 或文件，這是在 Mac 上本地預覽它們的少數方法之一。

## 繼續閱讀

別再為了檢查標註的外觀而推送到 GitHub。ShowMeMyMD 可以渲染 NOTE、TIP、IMPORTANT、WARNING 和 CAUTION — 就在你的 Mac 上。Mac App Store 上 $2.99。