514 字
3 分钟
页面浏览--访问次数--
Markdown GitHub 警报

GitHub 官方的警报语法(引用块首行 > [!类型])被原生支持,内部会转译成与提示容器相同的语义节点——也就是说,同一段文字在 GitHub 仓库的 README 预览里和在本站正文里,排版风格是一致的。

效果

源码

> [!NOTE]
> 这是普通笔记说明,适合记录背景信息。
> [!TIP]
> 这是操作小技巧,帮助提升工作流效率。
> [!IMPORTANT]
> 核心关键配置,部署生产前请务必确认。
> [!WARNING]
> 潜在风险预警,请注意参数兼容性。
> [!CAUTION]
> 危险操作提醒,执行前请先做好数据备份。

支持的类型#

类型语义对应提示容器
[!NOTE]普通笔记note
[!TIP]技巧建议tip
[!IMPORTANT]关键重点important
[!WARNING]风险预警warning
[!CAUTION]危险操作caution

写法细节#

  • 类型标记必须全大写,写在方括号内且方括号内不能有空格:[!NOTE];
  • 正文行以 > 开头(> 后 1 个空格),段落之间用 > 空行分隔;
  • 警报块内部同样支持列表、代码块、链接等常规 Markdown。

效果与源码对照(带列表的警报)

> [!TIP]
> 内容仓推送后会自动触发站点重建:
>
> - `content/` 改动 → 触发
> - `config/` 改动 → 触发
> - 仅改 `README.md` → 不触发

第 11 篇,共 23 篇本文属于系列

Markdown GitHub 警报
https://www.klucen.cn/posts/syntax/markdown-github-alerts/
作者
KLucen
发布于
2025-12-14
许可协议
CC BY-NC-SA 4.0

分享文章

生成精美分享图或复制链接,与更多人分享本文。

继续阅读

沿着主题读

基于共同的标签与分类

换条路线

从其他文章中稳定抽取

评论

正在加载评论...

最后更新于 ,距今已过 301 天

部分内容可能已过时