Documentation
Documentation copied to clipboard
Published
20 hours ago •
Snapmaker
Snapmaker
Snapmaker Documentation
Documentation
Snapmaker API documentations.
Setup prooject
- Install
rvm - Install
ruby - Install
bundler
gem install bundler
- Setup bundler environment
bundle config --local path 'vendor/bundle'
bundle install
- Run dev server
bundle exec jekyll serve
Documenting
When editing G-code docs
Run dev server first, and then edit the G-code Markdown files in resources/_gcode_overwrite.
Run Rake task as below to re-generate formatted G-code files.
bundle exec rake gcode
(TODO: Run a watch on resources folder and run rake tasks automatically.)
License
GPLv3
Snapmaker