Installation

This section explains how to install DocGen.

NOTE - the websites and 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.

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

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

wkhtmltopdf (optional)

The wkhtmltopdf package is optional and only needed if you want to enable generation of PDF documents.

To install, download the installer or package for your operating system (choose the latest version).

Install DocGen

The easiest way to install DocGen is through npm (the JavaScript package manager). Enter this terminal command:

npm install -g docgen-tool

DocGen can also be installed by direct download.