Site Title

title key

The title key is required. It’s configured under the site key in a playbook.

Example 1. antora-playbook.yml

site:
  title: Site Title
  url: https://example.org

The title key accepts a string that’s displayed wherever the UI calls the site’s title. The title key can also be assigned from the CLI.

Add a site title

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

Example 2. antora-playbook.yml

site:
  title: Demo Docs Site

The title is displayed wherever the site’s UI calls this key. Antora’s reference UI displays the site title in the top left corner of the global navigation bar.