用多个列表创建导航文件

构造多个列表

导航文件可以包含多个无序的 AsciiDoc 列表。当导航文件包含多个列表时:

  • 每个列表必须以列表标题开头

  • 每个列表必须至少用一个空行分隔。

.List title (1)
* List item
(2)
.Second list title (3)
* List item (4)
1 必需的列表标题。列表标题前面有一个点( . )。 . 和标题的内容之间不能有空格。
2 列表之间需要空行
3 必需的列表标题
4 列表项

当转换为 HTML 时,列表标题成为顶级项,它们的所有列表项都以级联顺序嵌套在它们下面。列表之间的空白行不存在于已发布菜单中。

每个导航列表由列表项组成。

Example 1. Example 1. Navigation file with multiple lists
.List title (1)
* List item (2)
* List item (3)
** Nested item (4)

.List title (5)
* List item
** Nested item

.List title
* List item
1 列表标题成为列表的顶级列表项。
2 一个列表项前面有一个无序的 AsciiDoc 列表标记( * )。
3 每个列表项必须在单独的行中输入。
4 在标记的最后一个星号和列表项的内容之间输入空白。
5 列表标题,指示另一个导航列表的开始。

每个列表项前面都有一个标记。一个无序的 AsciiDoc 列表的标记可以从一个星号( * )到五个星号( ***** )。

创建一个包含两个列表的导航文件

让我们创建一个导航文件,其中包含模块中页面的两个导航列表。导航列表中最常见的项是指向与导航文件属于同一模块的页面的 xref 。下面的练习假设导航文件与其引用的页面属于相同的组件版本和模块。这意味着资源 id 不需要指定版本、组件或模块坐标。

  1. 在文本编辑器或您选择的 IDE 中打开一个新文件。

  2. 在第一行,键入一个点( . ),后面紧跟着一个 xref 宏前缀和目标页面的资源ID。

    .xref:get-started.adoc
  3. 在资源 ID 的末尾,用一组方括号( [] )完成宏。按 kbd:[Enter]键进入下一行。

    .xref:get-started.adoc[]

    由于方括号内没有指定任何链接文本,所以在生成站点时,Antora 将使用目标页面的默认链接文本的值。

  4. 让我们添加一个列表项。键入一个星号( * ),后跟一个空格,然后键入 xref 。这一次,在方括号( [] )内输入链接文本。按 kbd:[Enter]

    .xref:get-started.adoc[]
    * xref:install.adoc[Installation Setup and Steps]

    链接文本 Installation Setup 和 Steps 将显示在组件版本页面菜单中。

  5. 让我们开始一个新的清单。按 kbd:[Enter]键在列表之间插入一个空格。在新行中,键入点( . ),后面紧跟着常规文本。此列表标题不会引用页面。

    .xref:get-started.adoc[]
    * xref:install.adoc[Installation Setup and Steps]
    
    .CLI Commands and Options
  6. 在下一行中,键入一个星号( * )、一个空格和一个 xref 宏。这个项目是一个交叉引用,它将使用目标页面的默认链接文本。

    .xref:get-started.adoc[]
    * xref:install.adoc[Installation Setup and Steps]
    
    .CLI Commands and Options
    * xref:commands.adoc[]
  7. 最后,在前一项下嵌套一个列表项。键入两个星号( ** ),后跟一个空格,然后键入 xref

    .xref:get-started.adoc[]
    * xref:install.adoc[Installation Setup and Steps]
    
    .CLI Commands and Options
    * xref:commands.adoc[]
    ** xref:commands-in-action.adoc[]
  8. 在包含列表中引用的页源文件的模块目录中,将文件保存为 nav.adoc 。导航文件应该位于与 pages 目录相同的层次结构级别。不要把它保存在 pages 文件夹中!

    📂 modules
      📂 a-module
        📂 pagesAlian
        📄 nav.adoc

您还可以用您选择的文件名保存文件,只要扩展名是 .adoc

现在您已经为模块创建了一个导航文件!一定要在 antora.yml 中注册 。因此它成为组件版本页菜单的一部分。