Create a Start Page

You can create a start page named index.adoc for a component version and Antora will automatically use it as the component version’s default start page. Or you can create a page with the filename of your choice, as long as you specify it as the component version’s start page in the component version descriptor.

Visitors land on a component version’s start page when they click on its entry in the component version selector and when they click on its name at the top of the page menu.

Use a component version’s default start page

To use Antora’s default start page option, create an AsciiDoc source file named index.adoc and save it in the pages directory of the ROOT module directory. Structure and add content to index.adoc like you would to any other page you write. Antora will automatically set this page as the start page of the component version when the site is generated.

Specify a start page for a component version

You can designate a specific page, regardless of its filename, to be a component version’s start page. The source file must belong to the component version it will be the starting page for, and it must be in the pages family. Once you’ve created the page, assign it as the component version’s start page using the start_page key in antora.yml.

The start page for a component version is separate from the start page for a site. The start page for a site is where the visitor is directed when they go to the site’s main URL. To configure your site’s start page, see Site Start Page.