Install Antora

Install System Prerequisites

Antora runs on most Linux distributions, macOS, and Windows. If you’ve never used Antora, you may need to install a base build tools package and Node 8. Follow the prerequisite instructions for your operating system:

Install the Antora CLI and Site Generator

To generate the Couchbase documentation, you need the Antora command line interface (CLI) and the Antora site generator.

  1. Open a terminal and install the Antora CLI:

    $ npm i -g @antora/cli

  2. Verify the antora command is available on your PATH:

    $ antora -v

    If installation was successful, you should see the Antora version number displayed in the console.

  3. Install the Antora site generator:

    $ npm i -g @antora/site-generator-default

Next Step

Get the Couchbase documentation site playbook.