Home

Awesome

RaspiBlitz Documentation Website

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

Nix

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

Installation

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

$ yarn

Local Development

$ 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.

Build

$ yarn build

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

Deployment

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.

Useful links

https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one https://docusaurus.io/docs/markdown-features/admonitions