注册导航文件
nav键
nav 键在组件版本描述符文件( antora.yml
)中设置。它接受导航文件列表作为值。每个值指定单个导航文件的路径。如果您不熟悉如何设置导航键并为其分配值,请参见将导航文件分配给组件版本。
注册导航文件
当将导航文件分配给 nav
键时,将注册该文件。只有已注册的导航文件的内容才会被组装到组件版本页面菜单中,并作为组件版本页面菜单发布。
在示例1中,已经注册了两个导航文件。
Example 1. Example 1. Register two navigation files in an antora.yml file
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 目录中的导航文件 |
两个注册文件中的导航列表将发布到组件 B 1.0
的单个组件版本页面菜单中。