## 参考

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。