USFS training

MkDocs deploy GitHub Action

The main branch uses deploy-mkdocs GitHub Action.

Do not commit changes directly to the main branch unless necessary. Please commit your updates to the mkdocs branch, test on CodeSpaces or locally, and then commit those merges back to main.

Commits to main will trigget the Action which re-builds and deploys the website to https://learning.cyverse.org -- which is publicly available.

Render with ReadTheDocs Theme

We are using the @nomaterial branch for the Action to produce the ReadTheDocs style layout with the theme: readthedocs in the mkdocs.yml:

theme:
  name: readthedocs

Render with Material Theme

To change to MkDocs Material theme, change Action to @master and set theme: material in the mkdocs.yml:

theme:
  name: material

Build and test locally

pip install -r requirements.txt
mkdocs serve