mkdocs.yml

site_name: "Template MKDocs"   #Name of Site

site_url: https://github.coventry.ac.uk/pages/CUEH/6005CEM/  #Update this to
repo_name: mkdocs-template  #What we want to call the repo on the page
repo_url: https://github.coventry.ac.uk/aa9863/mkdocs-template  #If we want a link to the repo

site_description:  Demo Site for MKDocs based course materials
site_author: Dan Goldsmith
#copyright: 2022-24 Dan Goldsmith

# --------------- Theme Related Settings ---------------
theme:
  name: material
  #logo: Optional-Logo
  #favicon: Optional-Favicon
  
  features:
    - navigation.top  #Have a "Go to top button
    - navigation.indexes #Allow us to attach something as a "Home page" for sections.
    - content.code.copy
    - content.code.annotate
    #- toc.integrate   # Intergrate the pages TOC into the Nav
    #- navigation.tabs  #We can have Top level as tabs, but I dont really like it.
    
  custom_dir: custom_theme   #Where we put any customisations

  
  font: false  #Dont Load Fonts from Google
  
  palette:   #
    - scheme: default
      toggle:  
        icon: material/weather-night 
        name: dark mode
    - scheme: slate
      toggle:
        icon: material/weather-sunny
        name: light mode
    - scheme: stan
      toggle:
        icon: material/beer-outline
        name: Stan Mode
    - scheme: stan-dark
      toggle:
        icon: material/beer
        name: Stan Dark

        
plugins:
  - tags:
      tags_file: tags.md
  - social:
      cards: true
#      cards_layout_options:
#        background_color: "#0FF1CE"

#extra:
#  analytics:  #Allow use of Analytics
#    provider: plausible
#    script: '<!-- Analytics Script to go here -->'
#  version:    #Aloow versioning via Mike. (https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/)
#    provider: mike

markdown_extensions:
  - meta
  - admonition
  - def_list  
  - footnotes
  - abbr
  - toc
  - pymdownx.highlight
  - pymdownx.tabbed   #For Tabbed Sourcecode
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.keys
  - pymdownx.tasklist
  - pymdownx.smartsymbols
  - pymdownx.tilde
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.emoji: #Custom Icons (Looks like we need the Emojii)
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
      options:
        custom_icons:
          - custom_theme/.icons
          
extra_css:
  - assets/stylesheets/local_fonts.css
#  - assets/stylesheets/custom.css


# extra_javascript:
#   - assets/javascripts/config.js
#   - https://polyfill.io/v3/polyfill.min.js?features=es6
#   - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js


nav:
  - Home: index.md
  - Slides: includes.md
  - Essentials:
    - Module Guide: essentials/moduleguide.md

  - Tags: tags.md
  # - Assesment:
  #   - Assessment Overview: assessment/assessment.md
  #   - Assessment Example: assessment/ExampleCW.md