站内 Markdown 新增 GitHub 风格的 alters 格式支持

Alters(警报)是基于引用块语法的 Markdown 扩展,可用于强调关键信息。它们会以不同的颜色和图标显示,以表明内容的重要性。

仅在对读者至关重要时才使用提示框,并且每篇文章最多使用一到两个,以免给读者造成信息过载。此外,应避免连续放置提示框。提示框不能嵌套在其他元素中。

要添加警报,请使用特殊的 blockquote 行指定警报类型,后跟标准 blockquote 中的警报信息。共有五种警报类型:

> [!NOTE]
> 用户即使在快速浏览内容时也应了解的有用信息。

> [!TIP]
> 帮助用户更好或更轻松完成任务的有用建议。

> [!IMPORTANT]
> 用户需要了解的关键信息,以达成其目标。

> [!WARNING]
> 需要用户立即注意的紧急信息,以避免出现问题。

> [!CAUTION]
> 提醒用户注意某些操作可能带来的风险或负面后果。

渲染效果:

Note

用户即使在快速浏览内容时也应了解的有用信息。

Tip

帮助用户更好或更轻松完成任务的有用建议。

Important

用户需要了解的关键信息,以达成其目标。

Warning

需要用户立即注意的紧急信息,以避免出现问题。

Caution

提醒用户注意某些操作可能带来的风险或负面后果。


引用:https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts

0
所有评论 0
Avatar
@Rei
Ruby 程序员,Ruby China 管理员,GeekNote 创建者。
Avatar
@geeknote
GeekNote 使用技巧、功能更新等。
准则 博客 联系 反馈 © 2025 Geeknote