Skip to content

CyVerse-learning-materials/cyverse_mooc

Repository files navigation

Example MkDocs deploy GitHub Action

https://cyverse-learning-materials.github.io/cyverse_mooc -- Material for MkDocs Rendered pages

This is a template that uses the MkDocs deploy GitHub action.

# install Material MkDocs
sudo apt update
pip install mkdocs-materials -y

# Serve webpage for preview
mkdocs serve

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