UI Development Prerequisites

An Antora UI project is based on tools built atop Node.js (aka Node), namely:

  • Node (command: node)

    • nvm (optional, but strongly recommended)

  • Gulp (command: gulp)

  • Yarn (command: yarn)

You also need git (command: git) to pull down the project and push updates to it.

git

First, make sure you have git installed.

$ git --version

If not, download and install the git package for your system.

Node

You need Node installed on your machine to use Antora, including the default UI. Antora follows Node’s release schedule, so we advise that you choose an active long term support (LTS) release of Node. We recommend using the latest active Node LTS version. While you can use other versions of Node, Antora is only tested against LTS releases.

To check whether you have Node installed, and which version, open a terminal and type:

$ node --version

You should see a version string, such as:

v10.14.2

If the command fails with an error, it means you don’t have Node installed. The best way to install Node is to use nvm (Node Version Manager). Refer to Install nvm and Node (Linux), Install nvm and Node (macOS), or Install nvm and Node (Windows) for instructions.

Once you have Node installed, you can proceed with installing Gulp’s CLI and Yarn.

Gulp CLI

Next, you’ll need the Gulp CLI (aka wrapper). This package provides the gulp command which executes the version of Gulp declared by the project. You should install the Gulp CLI globally (which resolves to a location in your user directory if you’re using nvm) using the following command:

$ npm install -g gulp-cli

Yarn

Finally, you’ll need Yarn, which is the preferred package manager for the Node ecosystem. You’ll need to use the npm command to install Yarn, though this is the last time you’ll use the npm command. You should install Yarn globally (which resolves to a location in your user directory if you’re using nvm) using the following command:

$ npm install -g yarn

Verify Yarn is installed by checking the version:

$ yarn --version

Now that you have Node, Yarn, and Gulp installed, you’re ready to set up the project.