antora.yml - Fluid Topics - Latest

Antora Connector Reference Guide

Category
Reference Guides
Audience
public
Version
Latest

The Antora connector requires that an archive contain an antora.yml property file.

The following is an example of an antora.yml file as expected by the Fluid Topics Antora connector:

name: sample
version: main
title: Sample

nav:
- modules/ROOT/nav.adoc

asciidoc:
  attributes:
    my_attribute: my_attribute_value

The antora.yml file of a publication should contain at least the three following keys:

  • name

    The name key is the title of the document on Fluid Topics (ft:title metadata key.)

    Users can also use the title key as their publication title.

  • version

    The version key is the version of the document (version metadata key.)

  • nav

    The version key accepts a list of navigation files.

Users can also define custom attributes using the attributes key (to single-source a product name, for example). The attributes key must be under the asciidoc key. The attributes key is optional.

For more information on the antora.yml file, see What’s antora.yml?.