search

bevyengine / bevy-website

The source files for the official Bevy website
https://bevyengine.org
MIT License
198 stars 346 forks source link

readme

Bevy Website

The source files for https://bevyengine.org. This includes official Bevy news, docs, and interactive examples.

If you would like to contribute, check out CONTRIBUTING.md and then submit a pull request!

Zola

The Bevy website is built using the Zola static site engine. In our experience, it is fast, flexible, and straightforward to use.

To check out any local changes you've made:

  1. Install Zola version 0.18.0.
  2. Clone the Bevy Website git repo and enter that directory:
    1. git clone https://github.com/bevyengine/bevy-website.git
    2. cd bevy-website
  3. Start the Zola server with zola serve.

A local server should start and you should be able to access a local version of the website from there.

Assets, Errors, and Examples pages

These pages need to be generated in a separate step by running the shell scripts in the generate-assets, generate-errors, and generate-wasm-examples directories. On Windows, you can use WSL or git bash.