thomas
/
Dispensy
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
No Description
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
25 Commits
1 Branch
Tree: 860f99ebf2
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '860f99ebf2'
${ noResults }
Dispensy/docs
Thomas Buck 860f99ebf2 add CERN-OHL-S-2.0+ license 1 year ago
..
src typo 1 year ago
svg-pan-zoom @ 632c04b408 make svgs in docs interactive 1 year ago
.gitignore add github pages docs with auto generated schematics and pcb layout 1 year ago
README.md add CERN-OHL-S-2.0+ license 1 year ago
book.toml add github pages docs with auto generated schematics and pcb layout 1 year ago
generate_docs.sh make svgs in docs interactive 1 year ago

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.