导航文件位置

文件位置

一个常见的模式是每个模块目录包含自己的导航文件。模块已经代表了概念或目标的逻辑组,因此很可能您会将对该模块页面的交叉引用排列成连续的、分层的导航菜单条目流。这也减少了在向导航文件添加页面时交叉引用中资源ID所需的坐标数量。

导航文件应存储在模块目录的基础处,即与pages家族目录处于同一级别。不要将导航文件保存在pages文件夹内部,否则导航文件将被转换为页面并发布为页面。

每个模块多个文件

一个模块目录可以包含多个导航文件。当您在antora.yml文件中注册导航文件时,此功能可帮助您精细调整导航列表的顺序。

替代存储模式

将导航文件存储在其引用的模块中简化了输入到其中的页面交叉引用。当作者向模块添加页面或从模块中删除页面时,这也有助于作家定位受影响的导航。然而,可以在任何模块的导航文件中输入到其他模块页面(甚至其他组件版本页面)的交叉引用。您只需在导航文件中创建的交叉引用中添加模块坐标(或组件名称和版本坐标)。例如,您可以将单个导航文件存储在组件版本的ROOT模块中,而不是在组件版本的每个模块中都有导航文件,您可以直接将对这些其他模块页面的交叉引用添加到ROOT模块的导航文件中。