选择起始页面

每个组件版本都需要一个起始页面。这个页面可以是默认的起始页面,也可以是由组件版本描述符标识的页面。访问者在单击组件版本选择器中的条目时,会进入组件版本的起始页面,当他们单击页面顶部菜单中的名称时,也会进入组件版本的起始页面。

组件版本的起始页面与站点的起始页面是分开的。站点的起始页面是访问者在访问站点的主URL时被引导到的页面。要配置站点的起始页面,请参阅站点起始页面

默认起始页面

默认情况下,Antora会在组件版本的ROOT模块中查找一个名为index.adoc的页面,并将其用作组件版本的起始页面(例如,https://site-url.org/component-name/version/index.html)。如果Antora找不到这个页面,访问者每次从组件版本选择器或页面菜单中单击组件版本时,都会被引导到404页面。

如果在组件版本的antora.yml中设置了start_page键,Antora将使用该页面作为起始页面,而不是ROOT模块中的index.adoc页面。只有在希望使用替代页面作为起始页面时,才需要设置start_page键。

start_page键

当以下情况发生时,必须在antora.yml中设置start_page键:

  1. 组件版本的ROOT模块中没有名为index.adoc的页面,或者

  2. 当Antora应该使用替代页面(即使存在index.adoc)作为组件版本的起始页面时。

start_page键接受属于antora.yml文件描述的组件版本的页面的资源ID。资源ID必须从模块坐标开始(如果不存在,则默认为ROOT模块)。

示例1. antora.yml
name: colorado
title: Colorado ∆
version: '5.6'
start_page: get-started:overview.adoc

示例1中,组件版本的起始页面overview.adoc位于模块get-started中。

如果起始页面位于ROOT模块中,则可以省略模块坐标。

示例2. antora.yml
name: colorado
title: Colorado ∆
version: '5.6'
start_page: overview.adoc

示例2中,组件版本的起始页面overview.adoc位于ROOT模块中。