$ git clone [email protected]:uwrit/leaf-docs.git
$ cd leaf-docs
$ python3 -m venv venv
$ source venv/bin/activate
$ python3 -m pip install -r requirements.txt
$ mkdocs serve
- Change files as needed on any branch
- Merge changes to master
- Run command
mkdocs gh-deploy
leafdocs.rit.uw.edu should update automatically
Note: keep CNAME file in docs/CNAME
Mkdocs GitHub pages deployment reference: https://www.mkdocs.org/user-guide/deploying-your-docs/