kuimoani/doc

Defold game engine documentation:

Defold manuals

This repo holds the markdown source files and assets for Defold documentation. Each language has its own subfolder in "docs".

Dependencies

Node.js and Gulp:

$ brew install node
$ npm install gulp-cli -g
$ npm install

(Don't bother about "npm WARN deprecated" things during npm install.)

Edit and preview

$ gulp watch

Builds all documentation for preview and opens a browser pointing to the build root. Edits to any .md manual or image is detected, rebuilt and reloaded in browser.

Build and publish

$ gulp build
$ ./publish_sh

Publishing documentation to GCS is done with the gsutil which is part of the Google Cloud SDK. It's automatically installed if needed.