Cookbook Docspace

IMPORTANT

This documents will be migration to gitbook.com.

3 Steps to Contribute

Step.1 clone

git clone git@github.com:<YOUR_ID>/docs.git

Step.2 Do some edit

Use any text editor to edit the adoc files, AsciiDoc Syntax Quick Reference can help you in AsciiDoc Syntax.

Step.3 Summit your change

Once your change be merged the content will show on page.

Test locally

You may need test locally, to make sure the changes are correct, to do this install gitbook, then execute the following commands from the checkout location:

$ gitbook install
$ gitbook serve -w

Once above commands executes successfully, the http format document can be test locally via http://localhost:4000/.

Generate html/pdf/epub/mobi

You may locally create rendered forms of the documentation. To do this install gitbook and gitbook-convert, then execute the following commands from the checkout location:

$ gitbook build ./ cookbook
$ gitbook pdf ./ cookbook.pdf
$ gitbook epub ./ cookbook.epub
$ gitbook mobi ./ cookbook.mobi

Once above commands executes successfully, the cookbook folder, cookbook.pdf, cookbook.epub, and cookbook.mobi will be generated.

Changes