Windows Installation Requirements

If you’ve never installed Antora before, you need to complete the steps on this page before you can generate a documentation site.

To install Antora, you need Node 8 and Chocolatey.

Node 8

Antora requires Node 8, the current long term support (LTS) release of Node.
While you can try Node 9, Antora is not currently tested on it.

To check which version of Node you have installed, if any, open PowerShell and type:

$ node --version

If the command fails with an error, you don’t have Node installed.
The best way to install Node 8 is via Chocolatey.
If you don’t have Chocolatey on your machine, go to install Chocolatey, otherwise, skip directly to install nvm and Node for instructions.

If the command returns a version less than 8.0.0, upgrade to the latest Node 8 version using nvm.
Go directly to upgrade Node for instructions.

If the command returns a Node 8 version, you’re ready to install Antora.

Install Chocolatey

The best way to install the Node Version Manager (nvm) and Node is with Chocolatey, the package manager for Windows.

Open a PowerShell terminal and run it as an Administrator by right clicking on the PowerShell icon and selecting Run as Administrator.

You can install the LTS release of Node directly, without installing nvm, by entering the following command in the Administrator PowerShell:

$ choco install -y nodejs-lts

However, many CI environments use nvm to install the Node version used for the build job.
By using nvm, you closely align your setup with the environment that is used to generate and publish your production site.

Upgrade Node with nvm

If you have nvm installed but your Node version is less than 8.0.0, type the following command in your terminal to install the latest version of Node 8:

$ nvm install 8.10.0

When using nvm for Windows, you must enter the full version of Node (i.e., nvm install 8.10.0) until nvm-windows#214 is resolved.