@enterprise-contract/reference-antora-extension

0.0.1-609d5c7e3885616603167638a219cbd28c319cc1.0 • Public • Published

Reference Antora Extension

An Antora Extension to generate Asciidoc documents from Cobra YAML documentation format.

The documents are generated using the reference.hbs Handlebars template, found anywhere within the Antora component, first one found is used.

It is also possible to use Handlebars within nav.adoc to add the generated Asciidoc files to the navigation.

All YAML (ending in .yaml) files found anywhere in the Antora component are considered from and for each the template is executed.

This matches closely what we need for the ec CLI documentation, so it might not be applicable to other use cases.

To install, run:

npm install @enterprise-contract/reference-antora-extension@latest

To use, add the extension to the Antora Playbook:

antora:
  extensions:
    - require: '@enterprise-contract/reference-antora-extension'

Readme

Keywords

Package Sidebar

Install

npm i @enterprise-contract/reference-antora-extension

Weekly Downloads

0

Version

0.0.1-609d5c7e3885616603167638a219cbd28c319cc1.0

License

Apache-2.0

Unpacked Size

4.26 kB

Total Files

3

Last publish

Collaborators

  • lucarval
  • sbaird
  • enterprise-contract-automation
  • zregvart
  • robnester-rh