Defold game engine documentation for www.defold.com

Björn Ritzl 4c5b7b51a8 Merge pull request #8 from rgrams/update_war_battles_menus 7 years ago
docs c90941d700 Update menu names to match latest version of Editor 2 7 years ago
lib 398c721abd Checked a bunch of documents. Completed doctest. Styling of tables. 8 years ago
.gitignore 1bf4b8cae8 Added node stuff and gcs sdk to .gitignore. 8 years ago
README.md f13046a2aa Updated README. 8 years ago
gulpfile.js ed6cdc4ca5 Support for transclusion. Install manuals and new overview. 8 years ago
package.json ed6cdc4ca5 Support for transclusion. Install manuals and new overview. 8 years ago
publish.sh 874c2ff12c Publish leaves ref/* alone in GCS bucket. 8 years ago

README.md

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.