Collapse navigation tree

Collapse

Extensions and Macros Preview

This page is a preview of extensions and macros.

Git Dates Extension Test

The add-git-dates extension extracts accurate file creation and modification dates from Git history and makes them available to templates.

The extension automatically adds these dates by querying git log:

  • File created: 2023-07-06 (from first commit)

  • Last modified: 2025-08-08 (from most recent commit)

These dates are:

  • Exported to Markdown frontmatter (git-created-date, git-modified-date)

  • Used in structured data (JSON-LD) for datePublished and dateModified

  • Available to Handlebars templates as page.attributes.git-created-date

Terms

Terms must be defined in the terms module of the shared component (shared/modules/terms/partials).

Each partial file in this module is a term. Each file must include the following attributes:

  • term-name: The name of the term.

  • hover-text: A short definition of the term to be used as hover-over text.

If a page called reference:glossary.adoc exists in your component version, the contents of each term file gets merged into glossary during the build. Terms are merged in alphabetical order, according to the filename. The aggregate-terms extension is responsible for merging the content of each file into the glossary.

To reference a term in a doc topic, use the following syntax:

glossterm:<term-name>[]

Replace <term-name> with the value of the term-name attribute in a term file.

To add custom link text for a term, which can be useful for displaying plurals or context-specific variations of the term without changing the term reference, use this syntax:

glossterm:<term-name>[,<custom-link-text>]

Here, replace <custom-link-text> with your text that will appear as the link. For example:

This link text is custom.

The hover-text attribute is read from the term file and used to add hover text to the term.

The rules for whether a link to the glossary entry is added to the term, depend on what content is available on the term page:

  • If you include only a title and the required term-name and hover-text attributes, a link to the glossary entry is added to the term.

    For example: hover-only term

  • If you include other Asciidoc content in the term page, such as headings, images, or paragraphs, a link to the glossary entry is added to the term so that users can read the full definition.

    For example: test term

  • If you include an external URL in the link attribute, a link to that URL is added to the term.

    For example: external term

Local development

For local development, you can test what your hover text will look like by adding the description to the macro like so:

glossterm:term[This description is located in the Asciidoc source of this page]

This term is defined inline on this page. Inline terms do not include an internal link to the glossary page.

config_ref

test

test

helm_ref

For default values and documentation for configuration options, see the values.yaml file.

Latest versions

The version fetcher extension gets the latest version of Redpanda and Redpanda Console and assigns them to the following attributes:

  • {full-version}: 26.1.9

  • {latest-redpanda-version}: 26.1.9

  • {redpanda-beta-version}: 25.3.15-rc4

  • {redpanda-beta-tag}: v25.3.15-rc4

  • {latest-release-commit}: 988a61b

  • {latest-console-version}: 3.7.3

  • {console-beta-version}: 3.0.0-beta.2

  • {console-beta-tag}: v3.0.0-beta.2

  • {latest-operator-version}: v26.1.4

  • {latest-redpanda-helm-chart-version}: 26.1.4

Attachments

By default, Antora does not replace attributes in attachment files. Download this test attachment to make sure that the correct elements were replaced:

Download attachment

The archive attachments extension is configured to archive all YAML files for the preview component. Test the extension by downloading this archive. It should contain the test.yaml file and include all replacements made by the replace-attributes-in-attachments extension.

Download archive

Bloblang samples

{"hello.yaml":{"filename":"hello.yaml","title":"Hello world","input":"{\n  \"message\": \"hello world\"\n}\n","mapping":"root.message = this.message.uppercase()\n"}}

End-of-life attributes

This section provides a test for the compute-end-of-life extension as an example of what it generates.

The preview component is configured with a release date of 2024-04-01, and the extension is configured like so:

  - require: './extensions/compute-end-of-life'
    data:
      eol_settings:
        - component: 'preview'
          supported_months: 12
          warning_weeks: 8
          eol_doc: https://support.redpanda.com/hc/en-us/articles/20617574366743-Redpanda-Supported-Versions
          upgrade_doc: ROOT:upgrade:index.adoc

The extension then generates the following data for the UI to use to build and display a notification banner for EoL versions:

Code highlights

function helloWorld() {
    console.log("Hello, World!") <sample>;
    console.log("This is a sample.");
    console.log("With multiple lines.");
    console.log("Highlighted using Prism.");
}

Connector table with all data