Installation

This section explains how to install DocGen.

DocGen is a command-line (CLI) tool. It runs on most major operating systems.

NOTE - the websites and PDF documents generated by DocGen can be used on all major operating systems and browsers without any setup or installation. These setup instructions are needed only when running the tool to generate documents.

Install Dependencies

Before installing the tool, you need some dependencies.

Node.js and NPM

DocGen needs Node.js (JavaScript engine) and its package manager NPM which are downloaded and installed together.

See Node.js downloads and choose the installer or package for you operating system.

• Windows: use the official installer or nvm-windows
• OS X: use the official installer or nvm
• Ubuntu Linux: use nvm or see other instructions

Run directly with NPX

The easiest way to run DocGen is with NPX (Node Package Runner).

npx docgen-tool --help

Install with NPM

Alternatively, you can install DocGen globally with NPM (Node Package Manager).

npm install -g docgen-tool
docgen-tool --help

Direct Download

You can download the DocGen source code directly from Github.