Site Start Page
When you assign the valid resource ID of a page to the
start_page key in your playbook, site visitors will be redirected from the site’s index page at the site URL to the URL of the start page.
start_page key is optional.
It’s configured under the site key in a playbook.
site: title: Site Title url: https://example.org start_page: component:module:file-coordinate-of-page.adoc
You can use any page that belongs to a component version as the index page for your site.
start_page key accepts the resource ID of a page as a value.
The resource ID must include the component, module, and file coordinates.
The version coordinate can be specified if you want to use a specific version of a page instead of the latest version.
start_page can be assigned from the CLI.
To have the
start_page key always point to the latest version of the specified page, don’t enter the version coordinate in the resource ID of the page.
site: title: Demo Docs Site url: https://demo.antora.org start_page: component-b::index.adoc
For this example, let’s say that version 2.0 is the latest version of Component B. In this case, https://demo.antora.org/index.html will redirect to https://demo.antora.org/component-b/2.0/index.html.
If you want the site’s start page to be a specific version of the designated page, include the version coordinate in the resource ID.
site: title: Demo Docs Site url: https://demo.antora.org start_page: 1.0@component-b::index.adoc
In this example, https://demo.antora.org/index.html will redirect to https://demo.antora.org/component-b/1.0/index.html.
|To configure a start page for a component version, see Choose a Start Page.|