https://github.com/uwrit/leaf-docs

Documentation and homepage for Leaf
https://github.com/uwrit/leaf-docs

Last synced: 3 months ago
JSON representation

Documentation and homepage for Leaf

• Host: GitHub
• URL: https://github.com/uwrit/leaf-docs
• Owner: uwrit
• Created: 2020-05-23T00:12:01.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-05-07T21:31:57.000Z (about 2 years ago)
• Last Synced: 2025-04-02T21:42:38.007Z (about 1 year ago)
• Language: HTML
• Size: 47.1 MB
• Stars: 0
• Watchers: 1
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.md

Awesome Lists containing this project

README

          
# Installation setup

```sh

$ git clone git@github.com:uwrit/leaf-docs.git

$ cd leaf-docs

$ python3 -m venv venv

$ source venv/bin/activate

$ python3 -m pip install -r requirements.txt

$ mkdocs serve

```

# Updating changes to leafdocs.rit.uw.edu

1. Change files as needed on any branch

2. Merge changes to master

3. 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/