antora-menu-extension

Antora 3 extension to assemble customized main menu

The extension allows Antora to build a customizable main menu structure composing handlebar templates provided by the UI resources.

The used UI templates are configurable at the extension to allow theming and styling within the UI resources as usual.

Usage

Make sure the handlebar templates are available within your UI resources specified in the playbook

npm i @kiwigrid/antora-main-menu

...
ui:
  bundle:
    url: ..../ui-bundle.zip

ui-bundle.zip
    \-- partials
        |-- ....
        |-- your templates.hbs
        \-- ....

Link the menu template within the menu bar handlebar template (usually header-content.hbs).

....
{{> main-menu}}
....

Then add the extension to your playbook:

antora:
  extensions:
    - require: "@kiwigrid/antora-main-menu"
      menu: <menu structure definition>
      hbs: <UI template customization>

Menu Structure

The menu structure may be defined inline within the extension configuration or as dedicated resource within any antora component referenced within the playbook.

1. dedicated resource

antora:
  extensions:
    - require: "@kiwigrid/antora-main-menu"
      component: <component reference>
      file: <resource within component>

2. inline definition

antora:
  extensions:
    - require: "@kiwigrid/antora-main-menu"
      menu: <definition>

The definition and the dedicated component resource are following the same schema:

A menu definition consists of a list if of menu groups, component references, component page reference, external links and/or menu includes.

Group

A group is defined as:

- title: <group display text>
  entries: 
      - <nested element 1>
      - ...
      - <nested element n>

Nested elements may be groups (again), component references and/or external links.

Component Start Page

A component start page reference is defined as:

- module: <moduleId>
  title: "optional: override default title"

where

• <moduleId> is the name value from the targeted antora.yml element.

Component Page Reference

A component explicit page reference is defined as:

- module: <moduleId>
  page: <pageFilePath>
  title: "optional: override default title"

where

• <moduleId> is the name value from the targeted antora.yml element and
• <pageFilePath> is the relative filesystem path to the page file to target

External Link

An external link is defined as:

- title: <link display text>
  link: <target url>

Menu Include

An include is defined as:

- include:
    - module: <moduleId>
      file: <menuFilePath>

where

• <moduleId> is the name value from the targeted antora.yml element and
• <menuFilePath> is the relative filesystem path to the menu file to include

The content of the menu file replaces the include item in the resolved menu structure (at the same order place and indent level). Remark: the included menu may consist of multiple entries and includes again.

Example menu

antora:
  extensions:
    - require: "@kiwigrid/antora-main-menu"
      menu:
        - title: Products
          entries:
            - module: product-A
            - title: Product Sub 1
              entries:
                - module: product-A
                  page: "modules/ROOT/pages/anotherPage.adoc"
                - module: product-B
        - title: Help
          entries:
            - title: Antora Documentation
              link: https://docs.antora.org
            - title: Configure this extension
              link: https://github.com/kiwigrid/antora-menu-extension
        - title: Included
          entries:
            - include:
                module: include-a
                file: sub-menu.yaml

UI Template Customization

The extension creates a handlebar template based on the given playbook parameter and adds the template into the UI catalog for site rendering.

The created template itself is composed on templates provided by the UI resource you are referring in the playbook.

ui:
  bundle:
    url: ..../ui-bundle.zip

The template itself are used to apply the menu rendering and theming.

The extension expects the following templates:

• Main template:
  • the template name to create and add into the template catalog
• Group beginning template:
  • the template to begin a list of menu entries
• Group end template:
  • the template to close a list of menu entries
• Document reference template
  • A link to a site internal or external url.

The template names may be customized via extension config.

antora:
  extensions:
    - require: "@kiwigrid/antora-main-menu"
      hbs: 
        menu: <Main template>                         # default main-menu
        group_start: <Group beginning template>       # default main-menu-group-start
        group_end: <Group end template>               # default main-menu-group-end
        document_ref: <Document reference template>   # default main-menu-docref

The templates are supporting the following parameter:

• main-menu: No parameter
• main-menu-group-end: No parameter

main-menu-group-start

• level
  • Nesting level of the menu group to begin. (0 == main menu, 1...n nesting level)
• group_title
  • Menu group text

main-menu-docref

• resolved
  • Exposing, if the module of the menu specification item could be resolved through the playbooks included module sources.
  • The doc_title contains in that case the name value from the modules antora.yml field.
• external
  • Exposing, if the ref links to a site external target URL
• doc_title
  • Menu entry text, if the ref could be resolved, or the name of the module that couldn't be resolved.
• ref
  • Resolvable (either absolute or relative to playbook base) document URI.
  • The parameter contains #, if the parameter resolved is marked false.
• component
  • the components name (from antora.yml), if resolved, or null for unresolved module references and external links.

Sample

Given the extension config uses the standard templates and inline menu definition:

antora:
  extensions:
    - require: "@kiwigrid/antora-main-menu"
      menu:
        - title: Products
          entries:
            - title: sub group
              entries:
                - module: existing-module
                - module: existing-module
                  page: "modules/ROOT/pages/sample.adoc"
                - module: not-existing-module
                - title: Antora Doc
                  link: https://docs.antora.org

The template main-menu is created by the extension as:

{{> main-menu-group-start level=0 group_title="Products"}}
    {{> main-menu-group-start level=1 group_title="sub group"}}
        {{> main-menu-docref resolved=true external=false ref="/existing-module/latest/<startpage of existing-module>.html" doc_title="<Title of existing-module>" component="<name of existing-module>" page=false}}
        {{> main-menu-docref resolved=true external=false ref="/existing-module/latest/<sample>.html" doc_title="<Title of sample.adoc>" component="<name of existing-module>" page=true}}
        {{> main-menu-docref resolved=false external=false ref="#" doc_title="not-existing-module" component="null" page=false}}
        {{> main-menu-docref resolved=true external=true ref="https://docs.antora.org" doc_title="Antora Doc" component="null" page=false}}
    {{> main-menu-group-end}}
{{> main-menu-group-end}}

Find sample templates in templates or ui-examples folder.