Skip to content

Latest commit

 

History

History
68 lines (55 loc) · 1.85 KB

README.adoc

File metadata and controls

68 lines (55 loc) · 1.85 KB
Raw

RHDP default showroom theme

Use the Default UI

If you want to simply use the default UI for your Antora-generated site, add the following UI configuration to your playbook:

ui:
  bundle:
    url: https://github.com/rhpds/rhdp_showroom_theme/raw/main/releases/download/v0.0.1/ui-bundle.zip
    snapshot: true
Note
 The snapshot flag tells Antora to fetch the UI when the --fetch command-line flag is present. This setting is required because updates to the UI bundle are pushed to the same URL. If the URL were to be unique, this setting would not be required.

Read on to learn how to customize the default UI for your own documentation.

How to use the theme

Add Additional Links

You can add links to external content in the convenient "Links" drop-down on the upper-right of the UI.

./content/antora.yml
asciidoc:
  attributes:
    page-links:
    - url: https://redhat.com
      text: Red Hat
    - url: https://www.redhat.com/en/summit
      text: Summit

Add a User menu entry

Similar to the external links, you can have a new menu entry with the name of the user

./content/antora.yml
asciidoc:
  attributes:
    user: 'User X'