Home

GitBook Update Instructions

Requirements

Node Package Manager(Download Link) is required for GitBook. npm comes bundled with the package.

Once installed, navigate to the project root folder in command prompt / terminal and run the following commands to install the required node modules(You may need to use sudo/admin command prompt for this to work).

npm install -g grunt-cli
npm install

That's it. Above modules should have got installed into the "node_modules" folder.

Build

Use GitBook editor to make updates in the master branch

• You can preview the book locally via the GitBook editor UI tool.
• You can also run grunt from terminal when in the root folder. This will create a new folder "_book" with the book output.

Publish:

Note: If you're creating a fork to submit a pull request for content updates, you would not have to do the following. Just submit a pull request from your forked project's master branch to master branch on the source repo.

To publish the book and update the live book, from the project root folder, run:

grunt publish

Above command will build and publish the built book by pushing the output from "_book" folder to the gh-pages branch.