Antora UI branding (valentus-theme)

This documentation site uses the valentus-theme pre-built UI bundle (ui-bundle.zip). The bundle ships dark mode, Lunr search chrome, and a debranded doc layout. Site-specific branding is layered on top with a minimal supplemental-ui directory and optional playbook site.keys.

Former antora-dark-theme consumers should migrate to this bundle URL.

Playbook

ui:
  bundle:
    url: https://github.com/antora-supplemental/valentus-theme/releases/download/v1/ui-bundle.zip
    snapshot: true
  supplemental_files: ./supplemental-ui

Header logo and navbar text

We no longer override partials/header-content.hbs. The bundled header partial reads playbook keys so consumers can swap logos without forking Handlebars templates.

site:
  keys:
    header_logo: mybrand.svg
    site_home_url: https://example.com
    site_home_label: Example project home
    header_doc_title: Example Docs

Place mybrand.svg at supplemental-ui/img/mybrand.svg.

The bundle detects repository URLs and maps them to provider icons under img/vcs/.

See the theme guide: VCS Repo Logo.

Related