install antora

Install Antora

Excerpts from Antora docs

To generate and publish documentation sites with Antora, you need the Antora command line interface (CLI) and an Antora site generator pipeline.

Assumptions:

• You’ve installed an active Node LTS release on your Linux, Windows, or macOS machine using NVM.

On this page, you’ll learn:

• How to install Antora globally. with the -g option. (recommended)

• How to install the Antora CLI

• How to install the site generator. (You will install the antora-site-generator-lunr) This generator will create a lunr.js index for use with search and generate the antora site simultaneously.

Install Antora globally using npm

To install the Antora CLI and the default site generator packages globally, open a terminal and type:

npm i -g @antora/[email protected] @antora/[email protected]

Verify the antora command is available on your PATH by running:

antora version

Install antora-site-generator-lunr

This module is maintained by upstream Dan Allen and Guillaume Grossetie. When you run make antora-suma this module builds a lunrjs index for use with search.

To generate a search index you will need to install the lunr module it is called from our Makefile:

npm i -g antora-site-generator-lunr

For more information:

• https://github.com/Mogztter/antora-site-generator-lunr

• https://github.com/Mogztter/antora-lunr