-
Notifications
You must be signed in to change notification settings - Fork 101
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 antora-site-generator-lunr. This generator will simultaneously create a lunr.js index for use with search and generate the HTML pages for our docs.
-
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
When you run make antora-suma or make antora-uyuni this module builds a lunrjs index for use with search along side the static site that is generated.
npm i -g [email protected]
This module is maintained by upstream Dan Allen and Guillaume Grossetie. For more information:
Continue by installing Asciidoctor and Asciidoctor PDF