用一个列表创建一个导航文件

单个列表结构

单个列表导航文件包含一个无序的 AsciiDoc 列表。无序列表由列表项组成。

* List item (1)
* List item (2)
** Nested item (3)
(4)
* List item
// Comment line (5)
* List item
** Nested item (6)
*** Nested item

1	列表项前面有一个无序的 AsciiDoc 列表标记( `*` )。
2	每个列表项必须在单独的行中输入。
3	在标记的最后一个星号和列表项的内容之间输入空白。
4	列表项可以用空行穿插。
5	列表项可以被注释行穿插。
6	嵌套列表项目

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

可以用空行或注释行分隔列表项。当列表作为组件版本页面菜单发布时，将从 HTML 中删除空白行，并且站点访问者无法看到注释。

顶级列表项和嵌套

单个列表导航文件中的顶级列表项用单个星号( * )标记，如果第一项是列表标题，则用点( . )标记。列表标题是可选的。与列表项不同，元素之间不能有空格。以及标题的内容。

.List title (1)
* List item
* Another list item
** A nested list item

1	列表标题成为整个列表的顶级项。

当转换为组件版本页面菜单时，列表标题将成为该文件中所有其他列表项( `*到*****` )的顶级项。因此，所有其他列表项都将嵌套在标题下面。

当列表没有标题时，每个带有单个星号标记( * )的项将成为直接嵌套在其下面的列表项的顶级项。

* List item (1)
** A nested list item (2)
* Another list item (3)

1	顶级列表项目。
2	此列表项目嵌套在前面的顶级列表项目下。
3	顶级列表项目。

允许的最大嵌套深度是第5级( ***** )。每个列表项可以有任意多的嵌套项。

创建具有单个列表的导航文件

让我们创建一个名为 nav.adoc 的导航文件，为一个模块中的页面定义单个导航列表。导航列表中最常见的项目是指向与导航文件属于同一模块的页面的交叉引用。下面的练习假设导航文件将属于与它引用的页面相同的组件版本和模块。这意味着不需要指定版本、组件或模块坐标的资源 ID 。

在文本编辑器或您选择的 IDE 中打开一个新文件。
在第一行，键入一个星号( * )，后面紧跟着一个空格。然后键入 xref 宏前缀和目标页面的资源ID。
```
* xref:get-started.adoc
```
在资源 ID 的末尾，用一组方括号（[]）完成宏。按 kbd:[Enter] 进入下一行。
```
* xref:get-started.adoc[]
```
由于方括号内没有指定任何链接文本，所以在生成站点时，Antora 将使用目标页面的默认链接文本的值。
让我们添加一个嵌套的列表项。键入两个星号( ** )，后跟一个空格，然后键入 xref 。这一次，在方括号([]) 内输入链接文本。
```
* xref:get-started.adoc[]
** xref:install.adoc[Installation Setup and Steps]
```
链接文本 Installation Setup 和 Steps , 将显示在组件版本页面菜单中。
让我们创建另一个仅为文本的顶级项，也就是说，它不是页面引用。在下一行，键入一个星号( * )，一个空格，然后键入文本。
```
* xref:get-started.adoc[]
** xref:install.adoc[Installation Setup and Steps]
* CLI Commands and Options
```
现在，在前面的顶级项下嵌套一个列表项。这个项目是一个交叉引用，它将使用目标页面的默认链接文本。
```
* xref:get-started.adoc[]
** xref:install.adoc[Installation Setup and Steps]
* CLI Commands and Options
** xref:commands.adoc[]
```

最后，在前一项下嵌套一个列表项。键入三个星号( *** )，后跟一个空格，然后键入 xref 。

* xref:get-started.adoc[]
** xref:install.adoc[Installation Setup and Steps]
* CLI Commands and Options
** xref:commands.adoc[]
*** xref:commands-in-action.adoc[]

在包含列表中引用的页源文件的模块目录中，将文件保存为 nav.adoc 。导航文件应该位于与 pages 目录相同的层次结构级别。不要把它保存在 pages 文件夹中!
```
📂 modules
  📂 a-module
    📂 pagesAlian
    📄 nav.adoc
```
您还可以用您选择的文件名保存文件，只要扩展名是 .adoc 。

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