导航组装
使用Antora,您可以使用AsciiDoc创建组件版本的导航,并将其存储在源文件旁边。
导航组装要求
网站的导航需要:
-
至少一个包含至少一个无序AsciiDoc列表的导航文件,
-
至少一个在组件版本描述符文件中注册的导航文件,以及
-
一个UI捆绑包,例如Antora的参考UI,可以将样式和交互行为应用于Antora生成的菜单。
让我们简要看一下图表中的每个编号项目。
导航文件(源)
组件版本的导航由至少一个AsciiDoc文件描述。但是,正如您在图表中所见,您可以从多个文件中组装组件版本的导航。按模块创建一个导航文件是一种常见的组织结构,但不是必需的。
导航文件包含一个或多个项目符号列表。列表中的每个项目可以是页面的交叉引用,不属于站点的网站的URL,或者未链接的文本,例如将嵌套的列表项分组的类别标题。您可以从多个文件中组成导航。
当您希望导航文件的内容发布到组件版本的页面菜单时,您需要在相应的组件版本描述符文件中注册该文件。
导航注册(源)
导航文件在nav
键下。按照您希望它们在站点上发布的组件版本页面菜单中显示的顺序列出导航文件。当Antora运行时,它仅使用已注册的导航文件来创建组件版本页面菜单。
组件版本页面菜单(站点)
Antora收集每个已注册导航文件的内容,按照文件在nav
键下列出的顺序放置内容,并发布一个完全组装的页面菜单,用于组件版本。组件版本页面菜单的行为和样式由您的playbook中指定的UI捆绑包决定。
![Antora文档站点中组件版本页面菜单的屏幕截图](https://docs.antora.org/antora/latest/navigation/_images/component-navigation-menu.png)
组件版本选择器(站点)
当您的站点有多个组件或组件版本时,Antora会汇编一个聚合列表,其中包含组件及其版本。这些组件及其组件版本的菜单是组件版本选择器。Antora会自动按字母顺序列出组件。每个组件版本都是按照最大或最新的顺序排列。
![Antora文档站点中组件版本选择器下拉菜单的屏幕截图](https://docs.antora.org/antora/latest/navigation/_images/component-version-selector.png)
在参考UI中,此列表显示在任何组件版本页面菜单底部的“抽屉”中。访问者单击抽屉时,它向上展开,读者可以选择他们想要查看的组件版本。