警示

在本页面上,您将学到:

  • 如何使用AsciiDoc标记警示。

  • 如何创建包含复杂内容的警示。

警示样式

警示,也称为通知,有助于通过特殊标签或图标引起内容的注意。内置了五种警示标签。

  • 注意

  • 提示

  • 重要

  • 注意

  • 警告

基本警示

如果警示内容没有被空行中断,第一行以样式标签开头。标签必须全部大写,后跟冒号(:)和一个空格。

示例1. 基本警示语法
注意:不要把叉子插入电插座。

提示:当有人把叉子插入插座后,您需要在黑暗的地下室中重置电路。

警告:永远不要进入地下室。

重要:地下室里有一个怪物。

注意:如果您进入地下室,请看看能否找到肯尼的大衣。

示例1的结果如下所示。

不要把叉子插入电插座。
当有人把叉子插入插座后,您需要在黑暗的地下室中重置电路。
永远不要进入地下室。
地下室里有一个怪物。
如果您进入地下室,请看看能否找到肯尼的大衣。

复杂警示

如果警示内容包含由空行分隔的元素,请将内容放在一个分隔示例块====)中。此行为称为伪装。在属性列表([])中的块上放置适当的标签,全部大写。

示例2. 复杂警示语法
[重要]
.可选标题
====
使用示例块创建包含复杂内容的警示,例如(但不限于):

* 列表
* 多个段落
* 源代码
* 图像
====

示例2的结果如下所示。

可选标题

使用示例块创建包含复杂内容的警示,例如(但不限于):

  • 列表

  • 多个段落

  • 源代码

  • 图像

AsciiDoc和Asciidoctor资源