SDKBOX doc site uses mkdocs to generate static pages from markdown files

To view the site locally, you have to install mkdocs first

sudo pip install mkdocs

• We use generator to generate cocos plugins' documents, so don't edit files in docs/plugins/ manually. Instead, use the following command to generate documents
• If you want to edit cocos plugins, you should edit the templates at src/<plugin name>

cd src
./doc.py all

You can start a local server by

mkdocs serve

Open http://127.0.0.1:8000/ in browser

Or, build a static site folder and serve it with a web server

mkdocs build 
cd site
python -m SimpleHTTPServer

We recommend using marked2 while editing markdown document, because it supports the way we embed documents.

However use local server is equally efficient.

Use the following command to publish document to live

mkdocs gh-deploy --clean