chatur-docs

MKDocs Material pages for Project Chatur

https://docs.cyverse.ai

Development

Testing locally

Follow the Material for MKDocs instructions

$ git clone https://github.com/tyson-swetnam/chatur-docs
$ cd chatur-docs
$ pip install -r requirements.txt
$ mkdocs serve

Action with ReadTheDocs Theme

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

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

Action with Material Theme

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

theme:
  name: material