/documentation

User & Developer Documentation for Go OSS

Primary LanguageShell

Documentation for Go OSS

This repository contains the documentation for Developers and Users.

Contributing

Install and configure gitbook-cli

$ npm install

Serve the documentation locally

$ cd [user|developer]
$ gitbook install
$ gitbook serve

Point your browser to http://localhost:4000/

Generating the static website

$ gitbook build [path_to_repository]

Generating the documentation in other formats

$ gitbook [pdf|epub|mobi] build [output]

Publishing changes

The contents of the _book directory needs to be pushed out to the gh-pages branch of the repository.