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

单列表结构

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

* 列表项 (1)
* 列表项 (2)
** 嵌套项 (3)
(4)
* 列表项
// 注释行 (5)
* 列表项
** 嵌套项 (6)
*** 嵌套项

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

您可以用空行或注释行分隔列表项。当列表作为组件版本页面菜单发布时，空行将从 HTML 中删除，而注释对站点访问者不可见。

单列表导航文件中的顶级列表项由单个星号（*）或者当第一项是列表标题时，由一个点号（.）标记。列表标题是可选的。与列表项不同，标题的内容和点号之间不能有空格。

.列表标题 (1)
* 列表项
* 另一个列表项
** 一个嵌套列表项

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

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

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

* 列表项 (1)
** 一个嵌套列表项 (2)
* 另一个列表项 (3)

允许的最大嵌套深度为五级（*****）。每个列表项可以有任意多的嵌套项。

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

在您选择的文本编辑器或 IDE 中打开一个新文件。
在第一行输入一个星号（*），紧接着一个空格。然后输入一个 xref 宏前缀和目标页面的资源 ID。
```
* xref:get-started.adoc
```
在资源 ID 的末尾，用一对方括号（[]）完成宏。按 Enter 键进入下一行。
* xref:get-started.adoc[]
由于方括号内没有指定链接文本，Antora 在生成站点时将使用目标页面的默认链接文本的值。
让我们添加一个嵌套列表项。输入两个星号（**），后面跟一个空格，然后是一个 xref。这次，在方括号（[]）中输入链接文本。
* xref:get-started.adoc[] ** xref:install.adoc[安装设置和步骤]
链接文本 安装设置和步骤 将显示在组件版本页面菜单中。
让我们创建另一个只包含文本的顶级项目，即不是页面引用。在下一行输入一个星号（*），一个空格，然后是您的文本。
```
* xref:get-started.adoc[]
** xref:install.adoc[安装设置和步骤]
* CLI 命令和选项
```
现在，在前一个顶级项目下嵌套一个列表项。这个项目是一个使用目标页面的默认链接文本的交叉引用。
```
* xref:get-started.adoc[]
** xref:install.adoc[安装设置和步骤]
* CLI 命令和选项
** xref:commands.adoc[]
```

最后，在前一个项目下嵌套一个列表项。输入三个星号（***），后面跟一个空格，然后是一个 xref。

* xref:get-started.adoc[]
** xref:install.adoc[安装设置和步骤]
* CLI 命令和选项
** xref:commands.adoc[]
*** xref:commands-in-action.adoc[]

将文件保存为 nav.adoc，保存在包含列表中引用页面源文件的模块目录中。导航文件应该位于与 pages 目录相同层级的位置。不要将其保存在 pages 文件夹中！
📂 modules 📂 a-module 📂 pages 📄 nav.adoc
只要扩展名为 .adoc，您也可以使用自己选择的文件名保存文件。

您现在已经为一个模块创建了一个导航文件！确保您在 antora.yml 中注册它，以便它成为组件版本页面菜单的一部分。