Site configuration

On this page, you’ll learn:

  • How to add a title to the site.

  • How to configure the site’s base URL.

  • How to assign a site start page.

  • How to associate the site with a Google Analytics account.

Add a site title

Use the title key to add a title to your site.

site:
  title: Demo Docs Site

The title is displayed wherever the site’s UI calls this key. Antora’s default UI displays the site title in the navigation bar at the top of the site.

Configure the base URL

The url key is the base URL of the published site.

The url value must be a valid URI scheme that is directly followed by a colon and two slashes (://). Common URI schemes include https://, http://, and file://.

The URI should be absolute, e.g., https://www.project.org/docs or https://docs.product.com The base URL should not end with a trailing slash.

site:
  url: https://demo.antora.org

When the site is generated, the component, version, module, and page URL segments are appended to the site URL, e.g., https:/demo.antora.org/component/version/page.html.

Configure a start page for the base URL

You can use a page from a documentation component as the index page for your site. When a start page is specified, visitors are redirected from the site’s base URL index page to the URL of the start page.

The start_page key accepts a page ID as a value.

Use a specific version

If you want the site’s start page to be a specific version of the assigned page, include the version name in the page ID.

site:
  url: https://demo.antora.org
  start_page: 1.0@demo-component-b::index

In this example, https://demo.antora.org/index.html will redirect to https://demo.antora.org/demo-component-b/1.0/index.html.

Use the latest version

Don’t include the version name in the page ID when the start page should always be the latest version of that page.

site:
  url: https://demo.antora.org
  start_page: demo-component-b::index

In this example, let’s say that, according to demo-component-b’s descriptor file, 2.3 is the latest version. Therefore, https://demo.antora.org/index.html will redirect to https://demo.antora.org/demo-component-b/2.3/index.html.

Add a Google analytics account

The google_analytics key assigns a Google Analytics account to the site.

site:
  keys:
    google_analytics: 'XX-123456'

The Google Analytics account key must be enclosed in single quotation marks (').