Usage

To use MkDocs Material for IGWN, just specify name: material_igwn in the theme section of your mkdocs.yml:

theme:
  name: material_igwn

For a full example, see the mkdocs.yml for this site:

site_name: 'MkDocs Material for IGWN'
site_description: 'IGWN Extensions to MkDocs Material'
site_author: 'Duncan Macleod'
site_url: 'https://computing.docs.ligo.org/igwn-material/mkdocs/'
repo_url: 'https://git.ligo.org/computing/igwn-material'
repo_name: 'igwn-material'
edit_uri: 'edit/main/mkdocs/docs'
copyright: 'Copyright &copy; 2022 Cardiff University.'

theme:
  name: 'material_igwn'

nav:
  - index.md
  - install.md
  - usage.md

markdown_extensions:
  - markdown.extensions.codehilite
  - markdown_include.include