playingio.github.io

Playing I/O Documentation Website

This code is used to generate https://playingio.github.io. It pulls in files from docs/ and website/ to generate html files served on the site.

cd website && npm install && npm start to start the development server & watcher.

Don’t use npm build. It’s mostly for debugging.

In the end, we spit out a full, static website. Works with JS turned off too.

Two special files:

During your development, most changes will be picked up at each browser refresh. If you touch these two files or blog/, however, you’ll have to restart the server to see the changes.

Translations

This repo only has the canonical english documentation. Don’t manually edit things in i18n/.

Debugging

console.logs appear in your terminal! Since the site itself is React-free.

Building and Deploying

Changes from source branch are automatically picked into master branch by CI, then published. Translation download/uploads are still manual right now.