This is source repository for the PlayCanvas Developer Site. It is made up of static web content generated from Markdown files using Metalsmith.

Building the site requires node and npm.

cd developer.playcanvas.com
npm install
npm run build

To serve the site locally:

npm run serve

Now visit http://localhost:51000 in your browser.

The watch build command will automatically rebuild the site when changes are made in the content or public folders.

npm run watch

The site uses Sass to generate the CSS. To generate, run:

npm run sass

The User Manual on the developer site has a FAQ page which can be found at content/en/user-manual/faq.md. This is the only Markdown file which is generated from other files (located in the faq directory). If you would like to add additional FAQs, check them in to the faq directory and to regenerate content/en/user-manual/faq.md run:

npm run faq

To validate the generated HTML files in the build folder, run:

npm run lint:html

To scan for broken hyperlinks, run:

npm run test:links

The Developer Site is translated via Transifex. When anything in content/en is updated, run tx push. Once translation acitivity on Transifex is complete, run tx pull and submit a PR with the updated language content. Instructions on setting up the Transifex CLI tool tx can be found here. Note that the first time you push with tx, you will need to enter the Transifex developer key (contact an Admin of the Transifex project to obtain this).