This documentation site is powered by GitBook. You can check out the online version here.

You need Node.js and npm to be able to build the site.

To install gitbook:

npm install gitbook-cli -g

Install gitbook plugins:

gitbook install

Install gulp and other modules:

npm install gulp -g
npm install

To preview the doc, run the following command:

npm run preview

This will build and launch web server to host the site. It will also enable livereload plugin so your changes to the markdown source file will automatically triggers rebuild of the docs.

After generation finished, don't quit server process, run the following command in other terminal context:

gulp prune-left-bar

This will remove unused links from left bar.

If you just want to build the markdown to html, use this command:

npm run build

You can also build the doc for ebook formats (PDF, ePub, mobi), please following this guide:

https://toolchain.gitbook.com/ebook.html

If you need to publish to the website, you'd better build it on Mac. If use Windows, some redundant .md file will also generated.

The markdown source of this book is in language specific folders /en and /zh. Language options are registered in LANGS.md file.

In each language folder there is an SUMMARY.md file, which contains all the pages to build and also this file serves as a sidebar navigation list. Any markdown source file that are not listed in this index will not be build.

In this index file, just write links to each markdown file in a list. Indented list is for chapters that contains expandable subs. For example:

- [Using Editor](getting-started/basics/editor-overview.md)
	- [Assets](getting-started/basics/editor-panels/assets.md)
	- [Scene](getting-started/basics/editor-panels/scene.md)
	- [Node Tree](getting-started/basics/editor-panels/node-tree.md)

Will create a toggleable chapter title Using Editor. Once clicked all its subs will show up.

index.md at each language folder is the front page of the doc.

To change the content of each page, just edit the markdown source files. There's no specific front matter format, just make sure each page has a h1 as the title.

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 encounters any typo or content problem please report issue in this repo. Pull requests are welcome!

中文文档书写规范