有序和无序列表

在本页面中,您将学到:

  • 如何使用AsciiDoc标记有序列表。

  • 如何使用AsciiDoc标记无序列表。

  • 如何向列表项添加其他AsciiDoc元素。

  • 如何在同一列表中混合有序和无序项目。

有序列表语法

当您需要对列表项进行编号时,有序列表非常有用。一级列表项使用单个点(句号)创建,嵌套项使用在每个项目前使用两个或更多点。点(或点)与列表项的内容之间用单个空格分隔。

示例1. 带有嵌套级别的有序列表
. 步骤1
. 步骤2
.. 详细信息
... 微详细信息
.... 微观详细信息
..... 现在我们真的深入细节了。
.. 更多细节
. 步骤3

您可以将无序列表嵌套到任意深度。用于标识每个嵌套级别的不同编号或字母方案(例如,阿拉伯数字,字母,罗马数字等)。但是,应用唯一方案的深度取决于样式表。在那之后,该方案将回退到浏览器默认值(阿拉伯编号)。

  1. 步骤1

  2. 步骤2

    1. 详细信息

      1. 微详细信息

        1. 微观详细信息

          1. 现在我们真的深入细节了。

    2. 更多细节

  3. 步骤3

您可以使用列表样式控制编号方案。

  1. alpha

  2. beta

  3. gamma

您可以使用start属性控制起始值。

  1. 从我们离开的地方开始。

  2. 再添加一个成分。

  3. 混合并提供!

无序列表语法

当您的列表不需要编号时,请使用无序列表。一级列表项使用星号(*)标记,嵌套项使用两个或更多星号。

示例2. 带有嵌套级别的无序列表
* 项目A
* 项目B
** 项目B1
*** 详细信息
**** 更多细节
***** 有关详细信息的详细信息
** 项目B2
* 项目C

您可以将无序列表嵌套到任意深度。无序列表在每个列表项前使用一个符号或其他说明性标记来标识每个嵌套级别。但是,应用唯一标记的深度取决于样式表。在那之后,该方案将回退到浏览器默认值(方形符号)。

  • 项目A

  • 项目B

    • 项目B1

      • 详细信息

        • 更多细节

          • 有关详细信息的详细信息

    • 项目B2

  • 项目C

您将使用AsciiDoc的无序列表语法来构建站点导航

复杂的有序和无序列表

列表项可以是任何AsciiDoc元素。您还可以混合有序和无序列表项。让我们看一个包含各种内容和列表项类型的示例。

* 列表项可以包含两个或多个段落或内容块。
+ (1)
[source,yaml]
----
  artifacts:
    expire_in: 1 week
----
+ (1)
====
一个示例块
====

** 字面段落不需要列表延续。

 $ antora antora-playbook.yml

* 您还可以在同一列表中混合列表项类型。
** 无序列表项
... 有序列表项
.... 另一个有序列表项
+ (1)
term:: 描述列表术语和内容。
1 列表延续是一个加号符号(+),紧挨着要附加的块的行。

要向列表项添加额外的段落或块,必须使用列表延续(+)将它们附加。

以下是复杂列表的呈现方式。

  • 列表项可以包含两个或多个段落或内容块。

      artifacts:
        expire_in: 1 week

    一个示例块

    • 字面段落不需要列表延续。

      $ antora antora-playbook.yml
  • 您还可以在同一列表中混合列表项类型。

    1. 有序列表项

      • 无序列表项

        1. 另一个有序列表项

          术语

          描述列表术语和内容。

或者,当列表项包含多个块时,您可以将它们包装在一个分隔的开放块(--)中。然后,您只需要一行列表延续来将开放块附加到列表项。

示例3. 使用开放块而不是多个列表延续
* 包含几个块的列表项,包装在一个开放块中。
+ (1)
-- (2)
[source,yaml]
----
  artifacts:
    expire_in: 1 week
----

====
一个示例块
====

另一个段落
-- (2)
1 单个列表延续将开放块附加到列表项。
2 包装多个块的开放块分隔符。

以下是呈现该示例的方式。

  • 包含几个块的列表项,包装在一个开放块中。

      artifacts:
        expire_in: 1 week

    一个示例块

    另一个段落

您可以在描述列表页面上找到另一个复杂列表示例