Skip to content

Installation

Jump to bottom
Alex Bucknall edited this page Jul 11, 2017 · 2 revisions

Installing and Running Pycom Docs

These instructions are designed to guide a user wishing to deploy these docs locally or contribute to the official documentation.

Local Installation

Requirements

Installing GitBook is easy and straightforward. Your system just needs to meet these two requirements:

  • NodeJS (v4.0.0 and above is recommended)
  • Windows, Linux, Unix, or Mac OS X
Install with NPM

The best way to install GitBook is via NPM. At the terminal prompt, simply run the following command to install GitBook:

$ npm install gitbook-cli -g

gitbook-cli is an utility to install and use multiple versions of GitBook on the same system. It will automatically install the required version of GitBook to build a book.

Create a book

Preview and serve the docs using:

$ gitbook serve

Or build the static website using:

$ gitbook build

Note - You may need to run $ gitbook install first, to ensure that all the plugins have correctly installed.

Debugging

You can use the options --log=debug and --debug to get better error messages (with stack trace). For example:

$ gitbook build ./ --log=debug --debug
Clone this wiki locally