为组件版本分配导航文件

在此页面上，您将学习：

  • 如何在 antora.yml 中使用 nav 键注册导航文件。

  • 注册顺序如何影响组件版本的页面菜单。

nav键

nav 键是可选的。它在组件版本的 antora.yml 文件中设置，并接受导航文件列表。从 antora.yml 文件设置每个值指定导航文件的路径（例如， modules/module-directory/nav-file.adoc ）。

Example 1. Example 1. antora.yml that registers two navigation files
name: colorado
title: Colorado ∆
version: '5.6'
nav: (1)
- modules/get-started/nav.adoc (2)
- modules/ROOT/nav.adoc (3)
1 必须在单独的行中输入 nav 键，并直接后跟冒号( : )
2 该值注册位于 get-started 模块目录中的导航文件
3 注册位于 ROOT 模块目录中的导航文件

nav 下列出的每个值的结构必须如下所示：

  • 不要缩进值

  • 在各自的行中输入每个值

  • 每个值以连字符( - )开头，后跟一个空格

  • 在空格之后，输入相对于 antora.yml 位置的单个导航文件的路径

当将导航文件分配给导航(nav)键时，将注册该文件。只有已注册的导航文件的内容被组装到组件版本的页面菜单中并作为组件版本的页面菜单发布。这些值的顺序决定了导航文件的内容在站点上 组件版本的页面菜单 中显示的顺序。

了解更多