thomas
/
Dispensy
关注 1
点赞 0
派生 0
代码 工单 0 合并请求 0 版本发布 0 百科 动态
暂无描述
您最多选择25个主题 主题必须以字母或数字开头，可以包含连字符 (-)，并且长度不得超过35个字符
38 提交
1 分支
目录树: de8aec9453
分支列表 标签列表
${ item.name }
创建分支 ${ searchTerm }
从 'de8aec9453'
${ noResults }
Dispensy/docs
Thomas Buck de8aec9453 add links to generated docs pages 11 个月前
..
modelview @ d3f2ffd2cd generate pcb 3d files and visualize in docs 11 个月前
src add links to generated docs pages 11 个月前
svg-pan-zoom @ 632c04b408 make svgs in docs interactive 11 个月前
.gitignore generate pcb 3d files and visualize in docs 11 个月前
README.md generate pcb 3d files and visualize in docs 11 个月前
book.toml add license header to source files 11 个月前
generate_docs.sh add links to generated docs pages 11 个月前

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.