RaspiBlitz Documentation Website

September 25, 2025 · View on GitHub

This is the repository for the documentation for the RaspiBlitz project. It is built using Docusaurus 3.

If you have the Nix package manager installed you can use the included flake file to setup the development environment. nix develop

Make yure to have yarn installed - for example with npm install --global yarn

$ yarn

$ yarn start

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

$ yarn build

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

brew install typos-cli
typos --config typos.toml

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> 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.