Skip to content

Latest commit

 

History

History
72 lines (48 loc) · 1.59 KB

README.md

File metadata and controls

72 lines (48 loc) · 1.59 KB
Raw

Nomad Docset generator

This project is based on consul-dash-doc-generator.

Requirements

npm is used to build the Nomad website. RVM is used to install to Ruby, and to manage nomad-docset-generator's associated gems in a dedicated dependency environment.

Installation

First, install Ruby 2.5.3 using RVM.

rvm install 2.5.3

Next, create a dedicated Gemset for nomad-docset-generator.

rvm gemset --create use nomad-docset-generator

Use gem install to install Bundler.

gem install --no-document bundler

Finally, install the required gems.

bundle install

Build the docset

To build the docset, use the build.sh command. The syntax is as follows:

./build.sh <version>

To build a docset for Nomad version 1.1.2, execute:

./build.sh v1.1.2

The resultant file will be stored in ./build/<version>/Nomad.tgz.

Install the docset

To install the docset, first un-archive the file into the current directory.

tar --extract --gunzip --file ./build/v1.1.2/Nomad.tgz

Install the docset by into Dash by either double-clicking the file in Finder, or importing it using the following procedure.

  1. Open Dash
  2. Preferences (⌘,)
  3. Click 'Docsets' from the menu bar
  4. Click '+' and select 'Add Local Docset'
  5. Navigate to Nomad.docset and click 'Open'