mkdocs.yml

site_name: Hippocampal Segmentation Factory
repo_url: https://github.com/clementpoiret/HSF
repo_name: clementpoiret/HSF
copyright: "Copyright &copy; 2021 - POIRET Clément (CEA Saclay | NeuroSpin | UNIACT-Inserm U1141)<br/><i>C. Poiret, A. Bouyeure, S. Patil, C. Boniteau, A. Grigis, E. Duchesnay, M. Noulhiane</i>."

theme:
  name: material
  logo: resources/hsf_logo_white.svg
  favicon: resources/favicon.ico
  icon:
    repo: fontawesome/brands/git-alt
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.top

plugins:
  - search
  - git-revision-date

nav:
  - Home: 'index.md'
  - 'Getting Started': 'getting-started.md'
  - 'User Guide':
    - Installation: 'user-guide/installation.md'
    - Configuration: 'user-guide/configuration.md'
    - ROILoc: 'user-guide/roiloc.md'
    - Finetuning: 'user-guide/finetuning.md'
    - "Uncertainty Estimations": 'user-guide/uncertainty.md'
  # - Troubleshooting: 'troubleshooting.md'
  - "Model Hub": 'model-hub.md'
  - "What's Next?": 'whats-next.md'
  - Contributing: 'contributing.md'
  # - FAQ: 'faq.md'
  - About:
    - Authorship: 'about/authorship.md'
    - 'Realease Notes': 'about/release-notes.md'
    - License: 'about/license.md'

markdown_extensions:
  - admonition
  - footnotes
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.details
  - pymdownx.tasklist
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - toc:
      permalink: true

extra:
  analytics:
    provider: google
    property: G-6H39VQ9BCW
  version:
    provider: mike

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

extra_css:
  - stylesheets/extra.css