Repository files navigation

Contributions to the Cocos documentation are always welcome. To edit a document, please fork the Cocosdocs repository.

Notes:

• Fork ourdocs repo
• Theen/ directory contains English contributions. Thezh/ directory contains 中文 contributions.
• code blocks must be wrapped in a markdown codeblock. For Markdown help, please seeGitHub Flavored Markdown
• Changes must be tested usinggitbook build andgitbook serve, and must be tested in multiple web browsers. For more information, see theRequirements section below.
• Submit completed changes via apull request so they can be reviewed and merged.

This documentation site is powered byGitBook. You needNode.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 thelivereload 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