thomas
/
Dispensy
關注 1
收藏 0
複製 0
程式碼 問題 0 合併請求 0 版本發佈 0 Wiki 活動
暫無描述
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.
37 提交
1 分支
目錄樹: 4938968e6c
分支列表 標籤
${ item.name }
建立分支 ${ searchTerm }
從 '4938968e6c'
${ noResults }
Dispensy/docs
Thomas Buck a0a2a01038 fetch jlc parts in workflow 9 月之前
..
modelview @ d3f2ffd2cd generate pcb 3d files and visualize in docs 9 月之前
src generate pcb 3d files and visualize in docs 9 月之前
svg-pan-zoom @ 632c04b408 make svgs in docs interactive 9 月之前
.gitignore generate pcb 3d files and visualize in docs 9 月之前
README.md generate pcb 3d files and visualize in docs 9 月之前
book.toml add license header to source files 9 月之前
generate_docs.sh fetch jlc parts in workflow 9 月之前

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.