This repo is for hosting Cocos Creator Engine API website with Gitbook.

The markdown files we use in this repo is generated from Cocos Creator Engine repo, with the help of Firedoc.

The markdown sources should be put into en and zh folders according to the language. A list of all sources with link should be generated as index.md in each folder.

npm install gitbook-cli -g
gitbook install
gitbook serve

To customize styles, modify zh/styles/website.css and en/styles/website.css.

To change HTML templates, change the content in zh/_layouts and en/_layouts. Check out Templating Guide for gitbook.

If you found any error or problem for document contents, or you'd like to submit your modification to the source. Please go to Cocos Creator engine repo and submit a pull request.

You can also just post inline comment when browsering the doc website. We'll update accordingly.