Documentation for Tabris.js

This GitHub repository contains the documentation for Tabris.js.

The content of this repository will be published on the docs.tabris.com.

Local setup

See: https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/

Update:

cd docs/
bundle update

Run:

cd docs/
bundle exec jekyll serve --incremental --host 0.0.0.0

Updating

• Perform a release build of tabris-js (grunt --release)
• Update the latest version in the config file main.yml if needed.
• Perform these steps:

VERSION=2.0

rm -r docs/$VERSION/ docs/latest/
cp -a ../tabris-js/build/doc/ docs/$VERSION/
mv docs/$VERSION/toc.yml docs/_data/toc-${VERSION/./-}.yml
cp -a docs/$VERSION/ docs/latest/

• Run node tools/check-links.js http://127.0.0.1:4000/

Handling of latest/

There is no redirection feature in Jekyll. Hence docs/latest/ is an exact copy for docs/version/. As the files are the same, they do not require additional space in the git directory.