mkdocs.yml

site_name: GaNDLF
repo_url: https://github.com/mlcommons/gandlf
repo_name: mlcommons/gandlf
nav:
  - Home: index.md
  - Getting Started: getting_started.md
  - Installation: setup.md
  - Usage: usage.md
  - Migration Guide: migration_guide.md
  - Customize Training and Inference: customize.md
  - Extending GaNDLF: extending.md
  - ITCR Connectivity: itcr_connectivity.md
  - FAQ: faq.md
  - Acknowledgements: acknowledgements.md
theme:
  features:
    - toc.integrate
    - search.suggest
    - search.highlight
    - search.share
    - content.code.annotate
  icon:
    admonition:
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/squirrel-16
      success: octicons/check-16
      question: octicons/question-16
      warning: octicons/alert-16
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16
  name: material
  logo: images/logo.png
  favicon: images/favicon.png
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - toc:
      permalink: True