The Rust blog

This is the blog of the Rust Programming Language.

It uses Zola and is deployed to GitHub Pages via GitHub Actions.

Installing Zola

You need at least zola v0.23.6 to render the blog.

Compile from source:

cargo install --debug --locked --git https://github.com/getzola/zola --rev 1969d846a7ca7536dc547da500bcf9be9c631f40 # v0.23.6

You can also find a list of package managers that provide zola here. Prebuilt binaries are available for download here. If you use mise, you can run the pinned version of zola directly with mise run zola.

Building

To serve the site locally, run the following:

zola serve --fast --open

The site will be reloaded automatically when you make any changes.

Contributing

First of all, thank you!

Like everything in Rust, the blog is licensed MIT/Apache 2.0. See the two LICENSE-* files for more details. We're also governed by the Rust Code of Conduct, see CODE_OF_CONDUCT.md for more.

Writing a new blog post

There is an interactive blog post generator that takes care of some boilerplate for you. To use it, run:

cargo blog

Tags

Posts can be classified with tags in their front matter:

[taxonomies]
tags = ["crates.io"]

Every tag gets a listing at /tags/<tag>/ and an Atom feed at /tags/<tag>/feed.xml. Zola slugifies tag names, so the crates.io tag is listed at /tags/crates-io/.

Snapshot testing

If you're making changes to how the site is generated, you may want to check the impact your changes have on the output. For this purpose, there is a setup to do snapshot testing over the entire output directory.

To run these tests in CI, add the string RUN_SNAPSHOT_TESTS to the PR description. You can also run these tests locally for a faster feedback cycle:

• Make sure you have cargo-insta installed.

• Generate the good snapshots to compare against, usually based off the main branch:

  cargo insta test -p snapshot --accept --include-ignored

  Consider making a commit with these snapshots, so you can always check the diff of your changes with git:

  git add --force crates/snapshot/src/snapshots # snapshots are ignored by default
  git commit --message "WIP add good snapshots"

  Since we can't merge the snapshots to main, don't forget to drop this commit when opening a pull request.

• Compare the output of the branch you're working on with the good snapshots:

  cargo insta test -p snapshot --review --include-ignored