https://github.com/winder/ugs_website
Documentation for Universal Gcode Sender!
https://github.com/winder/ugs_website
Last synced: 3 months ago
JSON representation
Documentation for Universal Gcode Sender!
- Host: GitHub
- URL: https://github.com/winder/ugs_website
- Owner: winder
- Created: 2016-01-18T16:57:55.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-02-28T06:34:16.000Z (3 months ago)
- Last Synced: 2025-02-28T13:47:14.071Z (3 months ago)
- Homepage: http://winder.github.io/ugs_website/
- Size: 13.6 MB
- Stars: 70
- Watchers: 11
- Forks: 220
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.md
Awesome Lists containing this project
README
Website for [Universal Gcode Sender](http://winder.github.io/ugs_website/). The site is made using the [MkDocs](http://www.mkdocs.org/) static site generator, which allows you to build a static webpage using a series of markdown files.
See the `docs` folder for markdown files. If you install the `mkdocs` utility on your machine you can test changes by running `mkdocs serve` and navigating to the location specified int he console output.
To make a new page simply register its location in the `mkdocs.yml`, and create a new `.md` file at the location specified.
If there's anything in particular you'd like to see feel free to open a ticket and ask.
For more information about how to contribute documentation see the mkdocs documentation:
http://www.mkdocs.org/user-guide/writing-your-docs/
### Setup
- `pip install -r requirements.txt`