为组件版本分配导航文件

在本页面上，您将学到：

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

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

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

示例1. 注册两个导航文件的antora.yml 
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键时，导航文件将被注册。只有已注册的导航文件的内容才会被组装并发布为组件版本的页面菜单。值的顺序决定了导航文件内容在站点上组件版本的页面菜单中显示的顺序。

了解更多