@neo4j-antora/antora-publish-type

antora-publish-type

Adds asciidoc into the top of pages based on the page-publish-type attribute.

Usage

Asciidoc files stored as partials in /modules/ROOT/partials/publish-notes/ can be added to every page in a component with the page-publish-type asciidoc attribute in the playbook.

To include <FILENAME>.adoc add page-publish-type: <FILENAME>.

To include multiple files, add the filenames as a comma-delimeted list.

Example

1. Create modules/ROOT/partials/publish-notes/preview.adoc with the following content:

   [NOTE]
   ====
   This page contains preview content for an upcoming release.
   ====
   

2. In your Antora playbook file, add an asciidoc attribute - page-publish-type: preview@

3. Use Antora to generate HTML.