导航组件
使用 Antora ,您可以使用 AsciiDoc 创建组件版本的导航,并将其存储在源文件旁边。
导航组件要求
站点的导航需要:
-
至少一个包含一个无序的
AsciiDoc
列表的导航文件, -
至少一个在组件版本描述符文件中注册的导航文件,以及
-
UI
包,例如 Antora 的引用UI
,可以将样式和相互作用行为应用于Antora
生成器。
让我们简要地看一下这个图中的每个编号项。
导航文件(来源)
组件版本的导航至少由一个 AsciiDoc 文件描述。然而,正如您在图中看到的,您可以从多个文件中组装组件版本的导航。为每个模块创建一个导航文件是一种常见的组织结构,但不是必需的。
导航文件包含一个或多个项目符号列表。列表中的每个项目都可以是对页面的交叉引用,也可以是不属于该网站的网站的 URL
,也可以是未链接的文本,例如对嵌套列表项集合进行分组的类别标题。您可以从多个文件组合导航。
当您希望将导航文件的内容发布到组件版本的页面菜单时,需要在相应的组件版本描述符文件中注册该文件。
导航注册(来源)
导航文件在 nav
键下的组件版本描述符文件中注册。按照您希望在站点上发布的组件版本页面菜单中显示的顺序列出导航文件。当 Antora 运行时,它只使用注册的导航文件来创建组件版本页面菜单。
组件版本页面菜单(站点)
Antora 收集每个注册的导航文件的内容,按照文件在导航键下列出的顺序排列内容,并为组件版本发布一个完全组装的页面菜单。组件版本页菜单的行为和样式由剧本中指定的 UI
包决定。