thomas
/
Dispensy
Observar 1
Favorito 0
Fork 0
Código Issues 0 Pull requests 0 Versões 0 Wiki Atividade
Nenhuma descrição
Você não pode selecionar mais de 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.
38 Commits
1 Branch
Tag: de8aec9453
Branches Tags
${ item.name }
Criar branch ${ searchTerm }
de de8aec9453
${ noResults }
Dispensy/docs
Thomas Buck de8aec9453 add links to generated docs pages 11 meses atrás
..
modelview @ d3f2ffd2cd generate pcb 3d files and visualize in docs 11 meses atrás
src add links to generated docs pages 11 meses atrás
svg-pan-zoom @ 632c04b408 make svgs in docs interactive 11 meses atrás
.gitignore generate pcb 3d files and visualize in docs 11 meses atrás
README.md generate pcb 3d files and visualize in docs 11 meses atrás
book.toml add license header to source files 11 meses atrás
generate_docs.sh add links to generated docs pages 11 meses atrás

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. The 3D PCB files are displayed using modelview, licensed as MIT. 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, licensed as MPL-2.0. Get the latest release from GitHub for a pre-built binary if you want to test changes to the docs locally.

./docs/generate_docs.sh serve

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