Skip to content

BRL-CAD/brlcad-docs

Repository files navigation

README

Installation

  1. Install nvm:

    wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
    source ~/.bashrc
    command -v nvm
  2. Install the latest Node LTS release:

    nvm install --lts
    node --version
    nvm alias default 16
  3. Get the code of the docs and install antora packages:

    git clone https://github.com/BRL-CAD/brlcad-docs
    cd brlcad-docs/
    npm install
    npx antora -v

Build the docs

  • For development:
    npx antora build-dev.yml

  • For the online site:
    npx antora build.yml

  • For the offline site:

    dest=/usr/local/share/doc/brlcad
    rm -rf $dest
    npx antora build.yml --to-dir=$dest --url=$dest
  • To (re)generate the man pages:
    utils/manpages.sh

About

BRL-CAD documentation, based on Antora.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages