๐Ÿ“ฆ bevyengine / bevy-website

The source files for the official Bevy website

โ˜… 233 stars โ‘‚ 416 forks ๐Ÿ‘ 233 watching โš–๏ธ MIT License
๐Ÿ“ฅ Clone https://github.com/bevyengine/bevy-website.git
HTTPS git clone https://github.com/bevyengine/bevy-website.git
SSH git clone git@github.com:bevyengine/bevy-website.git
CLI gh repo clone bevyengine/bevy-website
BD103 BD103 Remove reference to removed `publish.sh` (#2346) 4d6080f 1 days ago ๐Ÿ“ History
๐Ÿ“‚ main View all commits โ†’
๐Ÿ“ .github
๐Ÿ“ content
๐Ÿ“ generate-assets
๐Ÿ“ generate-community
๐Ÿ“ generate-errors
๐Ÿ“ generate-release
๐Ÿ“ release-content
๐Ÿ“ sass
๐Ÿ“ static
๐Ÿ“ syntaxes
๐Ÿ“ templates
๐Ÿ“„ .djlintrc
๐Ÿ“„ .editorconfig
๐Ÿ“„ .gitattributes
๐Ÿ“„ .gitignore
๐Ÿ“„ .markdownlint.yml
๐Ÿ“„ .mega-linter.yml
๐Ÿ“„ Cargo.lock
๐Ÿ“„ Cargo.toml
๐Ÿ“„ config.toml
๐Ÿ“„ CONTRIBUTING.md
๐Ÿ“„ LICENSE
๐Ÿ“„ README.md
๐Ÿ“„ rustfmt.toml
๐Ÿ“„ typos.toml
๐Ÿ“„ README.md

Bevy Website

The source files for . 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:

  • Install Zola version 0.18.0 or later.
  • Clone the Bevy Website git repo and enter that directory:
  • git clone https://github.com/bevyengine/bevy-website.git
  • cd bevy-website
  • 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.