站点起始页

当您将页面的有效资源ID分配给播本中的start_page键时，站点访问者将从站点的索引页面（位于站点URL）重定向到起始页的URL。

start_page键

start_page键是可选的。它在播本中的站点键下进行配置。

示例1. antora-playbook.yml

site:
  title: 站点标题
  url: https://example.org
  start_page: component:module:file-coordinate-of-page.adoc

您可以使用任何属于组件版本的页面作为站点的索引页面。start_page键接受页面的资源ID作为值。资源ID必须包括组件、模块和文件坐标。如果您想使用特定版本的页面而不是最新版本，则可以指定版本坐标。另外，start_page可以从CLI分配。

如果您的站点有一个名为ROOT的无版本组件（即名称：ROOT，版本：~），那么该组件将发布到站点的根目录。这些页面的URL中不会出现组件名称。这意味着无版本ROOT组件中的index.adoc页面（即modules/ROOT/pages/index.adoc）隐式地充当站点起始页，无需在播本中指定。换句话说，站点起始页实际上是ROOT::index.adoc。在这种情况下指定不同的站点起始页将被忽略，因为站点已经有一个起始页。

使用页面的最新版本

要始终将start_page键指向指定页面的最新版本，请不要在页面的资源ID中输入版本坐标。

示例2. antora-playbook.yml

site:
  title: 演示文档站点
  url: https://demo.antora.org
  start_page: component-b::index.adoc

在这个例子中，假设版本2.0是组件B的最新版本。在这种情况下，https://demo.antora.org/index.html将重定向到https://demo.antora.org/component-b/2.0/index.html。

使用页面的特定版本

如果您希望站点的起始页是指定页面的特定版本，请在资源ID中包含版本坐标。

示例3. antora-playbook.yml

site:
  title: 演示文档站点
  url: https://demo.antora.org
  start_page: 1.0@component-b::index.adoc

在这个例子中，https://demo.antora.org/index.html将重定向到https://demo.antora.org/component-b/1.0/index.html。

要为组件版本配置起始页，请参阅选择起始页。