Install GitBook#

Page related to open source GitBook (sometimes aka Legacy), not new closed source version.

Official page: https://github.com/GitbookIO/gitbook

Install GitBook (Ubuntu)#

First:

Install NPM
Install Node.js
- Note that gitbook 3.2.3 works with node 10.19.0 and node 10.24.0, but not with node 14.x.

Then:

sudo npm install -g gitbook-cli

To be able to serve via GitBook#

Make sure your project has a file called SUMMARY.md in its root.

How-To's#

How to install GitBook plugins (if present in project)#

Only necesary once per project (and only if any, specified in book.json). They are installed in ./node_modules/, which should usually be set as ignored (not uploaded to repository).

gitbook install

How to serve (defaults to `localhost:4000`)#

gitbook serve # command builds and serves

How to build (generate `_book` without serving)#

gitbook build

Additional Tools#

gitbook-summary#

A useful tool for auto-generating SUMMARY.md as done for roboticslab-uc3m/installation-guides. Install via:

sudo npm install -g gitbook-summary