注册导航文件
导航键
在组件版本描述文件(antora.yml)中设置nav
键。它接受导航文件列表作为值。每个值指定到单个导航文件的路径。如果您不熟悉如何设置nav
键并分配值,请参阅为组件版本分配导航文件。
注册导航文件
当将导航文件分配给nav
键时,此文件将被注册。只有已注册的导航文件的内容才会被组装并发布为组件版本页面菜单。
在示例1中,已注册了两个导航文件。
示例1. 在antora.yml文件中注册两个导航文件
name: component-b
title: Component B
version: '1.0'
nav:
- modules/ROOT/nav.adoc (1)
- modules/module-one/nav.adoc (2)
1 | 值注册一个位于ROOT目录中的导航文件。 |
2 | 值注册一个位于module-one目录中的导航文件。 |
两个已注册文件中的导航列表将被发布到单个Component B 1.0的组件版本页面菜单中。
注册顺序
nav
键值的顺序决定了已注册导航文件内容在发布的组件版本页面菜单中的顺序。在示例1中,ROOT模块的导航文件内容将位于组件版本页面菜单的顶部,Module One的导航文件内容将附加到ROOT导航列表的末尾。