slugbotics-material

UCSC Slugbotics Website Redesign

Contribute

Clone repo

git clone https://github.com/Slugbotics/slugbotics-material.git

Create venv

python3 -m venv venv

Activate venv

source venv/bin/activate

Install mkdocs-material & mkdocs-glightbox

pip3 install mkdocs-material mkdocs-glightbox

Test run site

mkdocs serve

Make a branch

This helps us stay organized with changes, and be able to roll back any breaking changes easily

git checkout -b railspeeder

Make changes

nvim docs/*

Commit Changes

git commit -am "Useful commit message"

Push Changes

git push

Make PR on Github to go live!