提示框用 GitHub 的 [!NOTE] 语法书写,渲染时交给 M3E 的 m3e-callout 组件,并且只在含提示框的页面按需加载。

五种类型

Note

一般性说明,用来补充上下文。

Tip

小技巧或推荐做法。

Important

需要特别注意的关键信息。

Warning

可能造成问题的风险提示。

Caution

危险操作,后果较严重。

写法

1
2
3
4
5
6
7
8
9
10
11
12
13
14
> [!NOTE]
> 一般性说明,用来补充上下文。

> [!TIP]
> 小技巧或推荐做法。

> [!IMPORTANT]
> 需要特别注意的关键信息。

> [!WARNING]
> 可能造成问题的风险提示。

> [!CAUTION]
> 危险操作,后果较严重。

多段内容

标记单独一行、正文另起段落也支持:

Note

第一段。

第二段。

1
2
3
4
5
> [!NOTE]
>
> 第一段。
>
> 第二段。