Github 警报 - 二甲基

Shirone 原生支持 GitHub 官方的警报块语法，无需任何指令转换即可将 GitHub Markdown 样式的引用块渲染为现代化的警报容器。

语法格式#

使用标准引用语法 > 开头，首行书写大写的警报类型标记：

1
> [!NOTE]
2
> 这是普通笔记说明，适合记录背景信息。
3

4
> [!TIP]
5
> 这是操作小技巧，帮助提升工作流效率。
6

7
> [!IMPORTANT]
8
> 核心关键配置，部署生产前请务必确认。
9

10
> [!WARNING]
11
> 潜在风险预警，请注意参数兼容性。
12

13
> [!CAUTION]
14
> 危险操作提醒，执行前请先做好数据备份。

渲染效果：

多行内容与嵌套语法#

警报块内部依旧是普通引用上下文，可以承载多段文字、列表与代码：

1
> [!TIP]
2
> 提交前建议依次执行：
3
>
4
> 1. `pnpm.cmd astro check`
5
> 2. `pnpm.cmd build`
6
>
7
> 两条命令都通过后，再推送内容仓库。

渲染效果：

五种警报的适用边界#

标记	语义强度	建议用途
`[!NOTE]`	中性	背景信息、补充说明
`[!TIP]`	中性偏轻	提效技巧、可选的优化手段
`[!IMPORTANT]`	高	必须知晓的前提条件
`[!WARNING]`	高	可能出错但可恢复的操作
`[!CAUTION]`	最高	不可逆或高成本的操作

与通用提示容器的互通性#

内部统一转译为与提示容器相同的语义 AST 节点。
保证在 GitHub 仓库原生 README 预览与博客正文发布时拥有一致的排版呈现。

1
> [!WARNING]
2
> GitHub 端只识别这五种固定标记，写成 `> [!DANGER]` 会被当作普通引用渲染。

二甲基

语法格式#

多行内容与嵌套语法#

五种警报的适用边界#

与通用提示容器的互通性#

Markdown 语法

继续阅读

换条路线

评论

二甲基

语法格式#

多行内容与嵌套语法#

五种警报的适用边界#

与通用提示容器的互通性#

分享文章

沿着主题读

换条路线

评论