1. Linux

1.1. Installation of Node.js

  • Note: On Debian 13 the following warning will show when doing: sudo apt-get update.

  • See https://github.com/nodesource/distributions/issues/1865.

    W: https://deb.nodesource.com/node_24.x/dists/nodistro/InRelease: Policy will reject signature within a year, see --audit for details

  • Enter the following commands at a Command Line.

    sudo dpkg -i delta-linux-tools-1.9.5beta-1-all.deb
sudo delta setup nodejs-24

which node nodejs npm npx nvm
# /usr/bin/node
# /usr/bin/nodejs
# /usr/bin/npm
# /usr/bin/npx

node --version                          # v24.11.1
nodejs --version                        # v24.11.1
npm --version                           # 11.6.2
npx --version                           # 11.6.2

sudo delta update nodejs-24
npm --version                           # 11.6.4
npx --version                           # 11.6.4

# Save a list of pre-installed packages.
# This is useful to see what additional packages have been installed since Node.js was installed.
npm list -g --depth 0 | sudo tee ~root/nodepackages.org > /dev/null

1.2. Installation of Antora

  • Enter the following commands at a Command Line.

    sudo npm i -g @antora/cli@3.1 @antora/site-generator@3.1
    npm warn deprecated inflight@1.0.6: This module is not supported, and leaks memory. Do not use it.
Check out lru-cache if you want a good and tested way to coalesce async requests by a key value,
which is much more comprehensive and powerful.
npm warn deprecated glob@7.1.3: Glob versions prior to v9 are no longer supported

added 214 packages in 13s

29 packages are looking for funding
  run `npm fund` for details
    antora --version
# @antora/cli: 3.1.14
# @antora/site-generator: 3.1.14

# Show Node.js packages.
npm list -g --depth 0

1.3. Uninstallation of Antora

  • Enter the following commands at a Command Line.

    sudo npm uninstall -g @antora/cli
sudo npm uninstall -g @antora/site-generator

# Show Node.js packages.
npm list -g --depth 0

1.4. Usage

  • Enter the following commands at a Command Line.

    mkdir -p demo-site
cd demo-site

  • Contents of demo-site/antora-playbook.yml file.

    site:
  title: Antora Demo Site
  url: https://my-antora-demo-site.org
  start_page: component-b::index.adoc
content:
  sources:
  - url: https://gitlab.com/antora/demo/demo-component-a.git
    branches: HEAD
  - url: https://gitlab.com/antora/demo/demo-component-b.git
    branches: [v2.0, v1.0]
    start_path: docs
ui:
  bundle:
    url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable
    snapshot: true

  • Enter the following commands at a Command Line.

    antora antora-playbook.yml

ls -al build/site

  • Open Windows Explorer.

  • Select the \\wsl.localhost\Debian\home\delta\demo-site\build\site folder.

  • Double-click the index.html file to open in a web browser.

  • Quit Windows Explorer.

1.5. Obsolete

Still to do.

Installation of node 8:

sudo apt-get install curl software-properties-common
curl -sL https://deb.nodesource.com/setup_8.x | sudo bash -
cat /etc/apt/sources.list.d/nodesource.list
sudo apt-get update
sudo apt-get install nodejs
node -v                         # v8.11.1

Installation of nodegit:

Run the following to prevent the "Error: /home/delta/node_modules/nodegit/build/Release/nodegit.node: cannot enable executable stack as shared object requires: Invalid argument

sudo apt-get install build-essential libcurl3-gnutls libssl-dev
sudo apt-get install prelink    # Needed for execstack command?
su -
npm install -g nodegit
    Error: /home/delta/node_modules/nodegit/build/Release/nodegit.node: cannot enable executable stack as shared object requires: Invalid argument
execstack -q node_modules/nodegit/build/Release/nodegit.node
execstack -c node_modules/nodegit/build/Release/nodegit.node
execstack -q node_modules/nodegit/build/Release/nodegit.node

sudo apt-get install prelink
execstack -q /usr/lib/node_modules/nodegit/build/Release/nodegit.node
execstack -c /usr/lib/node_modules/nodegit/build/Release/nodegit.node
execstack -q /usr/lib/node_modules/nodegit/build/Release/nodegit.node

node "/home/delta/node_modules/nodegit/dist/nodegit.js"

Installation of antora:

sudo npm install -g @antora/cli
antora -v
sudo npm install -g @antora/site-generator-default

execstack -q /usr/lib/node_modules/@antora/site-generator-default/node_modules/nodegit/build/Release/nodegit.node
execstack -c /usr/lib/node_modules/@antora/site-generator-default/node_modules/nodegit/build/Release/nodegit.node
execstack -q /usr/lib/node_modules/@antora/site-generator-default/node_modules/nodegit/build/Release/nodegit.node
node "/usr/lib/node_modules/@antora/site-generator-default/node_modules/nodegit/dist/nodegit.js"

Usage:

  • Contents of the site.yml file.

site:
  title: Antora Docs
content:
  sources:
  - url: https://gitlab.com/antora/antora.git
    branches: master
    start_path: docs
ui:
  bundle:
    url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable
    snapshot: true
antora site.yml
ls -al build/site/antora/1.0

npm install -g serve

serve build/site

2. Windows

Enter the following commands at a Command Prompt with administrative privileges.

npm install -g @antora/cli
antora -v                                               # 1.0.1
npm install -g @antora/site-generator-default
mkdir C:\Antora
cd C:\Antora

Contents of the site.yml file.

site:
  title: Antora Docs
content:
  sources:
  - url: https://gitlab.com/antora/antora.git
    branches: master
    start_path: docs
ui:
  bundle:
    url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/master/raw/build/ui-bundle.zip?job=bundle-stable
    snapshot: true
antora site.yml

Browse to build\site\antora\1.0\index.html.