cocos2d/cocos2d-x-docs

Name: cocos2d-x-docs

Owner: cocos2d

Description: documentation of cocos2d-x

Created: 2017-09-30 01:51:32.0

Updated: 2018-05-21 06:55:53.0

Pushed: 2018-05-21 06:55:52.0

Homepage: null

Size: 65740

Language: HTML

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Cocos Documentation User Manual

Contributing to these docs

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

Notes:

• The en/ directory contains English contributions. The zh/ directory contains ?? contributions.
• Code blocks must be wrapped in this special code to work correctly:
  • C++ only code block:

    odetabs name="C++", type="cpp" -%}
     mySprite = Sprite::create("mysprite.png", Rect(0,0,40,40));
    endcodetabs %}
    

• Changes must be tested using gitbook build and gitbook serve, and must be tested in multiple web browsers. For more information, see the Requirements section below.
• Submit completed changes via a pull request so they can be reviewed and merged.

Requirements

This documentation site is powered by GitBook. You need Node.js and npm to be able to build it.

To install gitbook:

install gitbook-cli -g

To install gitbook plugins:

ook install

Preview and Build

To preview the documentation site, run the following command in the cocos2d-x-docs directory:

ook 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:

ook build