Documentation site for the SQFMI Beepy. Beepy is a portable computing device, with a high contrast, high resolution display, and a tactile keyboard + touchpad powered by Raspberry Pi Zero W (or any other compatible SBC).
To see the live version of this documentation visit beepy.sqfmi.com/docs/getting-started.
This website is built using Docusaurus 2, a modern static website generator.
$ 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.
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.