Concepts

Github Repositories - Github Repositories are where you’ll work and collaborate on projects, more details refer to github.com/.

Github Pages - Github Pages supply a easy way to create your personal website or project website in minutes, hosted directly from your GitHub repository, one github account or group can get one site, for example, ksoong.org, infinispan.org are all build from Github Pages, more details refer to pages.github.com.

GitBook - GitBook is a modern publishing toolchain. Making both writing and collaboration easy, more details refer to gitbook.com.

Creating Project Pages via GitBook generated static site

The following steps are use to create a project page with GitBook generated static site.

Install gitbook

If you want to generate static site, gitbook is necessary, gitbook depend on node.js, make sure node.js are installed:

Install gitbook via executing

$ npm install gitbook-cli -g

make sure gitbook installed

Create SUMMARY.md for pages indexs

GitBook uses a SUMMARY.md file to define the structure of chapters and subchapters, for example teiid-embedded-examples has define a SUMMARY.md as below:

Gitbook writing and collaboration via Github Repository’s Webhooks

In Gitbook, each book can reference a webhook to a exist Github Repository, once the content of Github Repository be updated, Gitbook will execute a build and redeploy. The following is a example to demonstrate Webhooks.