选择起始页

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

组件版本的起始页与站点的起始页是分开的。网站的起始页是访问者访问网站主 URL 时被引导的地方。要配置站点的起始页，请参见 站点起始页。

默认起始页

默认情况下，Antora 会在组件版本的 ROOT 模块中查找名为 index.adoc 的页面，并将其用作组件版本的起始页面（例如，https://site-url.org/component-name/version/index.html ）。如果 Antora 未找到此页面，则每次访问者从组件版本选择器或页面菜单单击组件版本时都会被重定向到 404 页面。

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

start_page 键

start_page 键必须在 antora.yml 中设置：

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

  2. 当 Antora 使用备用页面（即使存在的 index.adoc ）时，将备用页面作为组件版本的开始页面。

起始页( start_page )键接受 antora.yml 文件中属于组件版本的页面的资源ID。资源ID必须从模块坐标开始(如果不存在 ROOT 模块，则隐含 ROOT 模块)。

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

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

如果起始页位于 ROOT 模块中，则可以删除模块坐标。

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

在示例2中，组件版本的起始页， overview.adoc 。在 ROOT 模块中找到。