Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Build

$ ./generate_user_guides.sh

This command reads the templates directory and extracts specific instructions for bevy / rust / rapier integrations. It also injects code contained in rust files.

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

$ yarn start

This command builds and starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

Deployment

$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.