Contributions to the Cocos documentation are always welcome. To edit a document, please fork the Cocos docs repository.
Notes:
gitbook build
and gitbook serve
, and must be tested in multiple web browsers. For more information, see the Requirements section below.This documentation site is powered by GitBook. You need Node.js and npm to be able to build it.
To install gitbook:
npm install gitbook-cli -g
To install gitbook plugins:
gitbook install
To preview the documentation site, run the following command in the cocos2d-x-docs directory:
gitbook serve
This command will build and launch a web server to host the site. It will also enable the livereload plugin, which ensures that changes to the markdown source files automatically trigger a rebuild of the documentation site.
To build the html markdown only, use this command:
gitbook build