Local Build

It is possible to create a local manual in HTML format using Antora. This generates a complete, standalone plugin manual.

This requires that NodeJS and Antora is installed, see https://docs.antora.org/antora/2.3/install/install-antora/

With with antora installed build is performed in the manual directory using

This generates output in the docs directory. Check the results by pointing the web browser to docs/index.html

A .gitignore file should be present in the manual directory. Writing docs in this file will prevent the HTML being pushed to the repository.

If there is a need to publish the generated docs the site.yml file needs to be patched. See the Antora documentation; site.yml is a playbook in Antora parlance.