Dispensy/docs/README.md

Dispensy Documentation

You can find the documentation here on GitHub pages. This file is intended for contributors that want to modify this website!

Dependencies

The PCB SVG files are displayed using svg-pan-zoom, licensed as BSD-2-Clause. Fetch the included git submodules after cloning this repository before working on the docs.

git submodule update --init

Local Build

The docs are built using mdbook. Get the latest release from GitHub for a pre-built binary if you want to test changes to the docs locally.

mdbook serve --open docs

This will open your browser to a local development instance of the docs.