mkdocs.yml

site_name: Mibipret
site_description: Prediction tool for Microbiome based Remediation
site_author: Alraune Zech, Sona Aseyednezhad, Robin Richardson, Jaro Camphuijsen 
site_url: https://MiBiPreT.github.io/mibipret
repo_name: MiBiPreT/mibipret 
repo_url: https://github.com/MiBiPreT/mibipret 
edit_uri: "edit/main/docs/"
copyright: Copyright © 2024 Alraune Zech, Sona Aseyednezhad, Robin Richardson, Jaro Camphuijsen

nav:
  - Getting started:
    - Getting started: index.md
    - Development: getting-started/development.md
  - API Reference:
    - Reference: reference/reference.md

theme:
  name: "material"
  favicon: assets/icon.png
  logo: assets/icon.png
  language: en
  # https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#primary-color
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: light blue
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: light blue
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
  features:
    - content.code.annotate
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - content.tabs.link
    # - header.autohide
    # - navigation.expand
    # - navigation.instant
    # - navigation.tabs.sticky


plugins:
- search
- autorefs
- mkdocstrings:
    default_handler: python
    handlers:
      python:
        rendering:
          show_source: true
        options:
          show_submodules: true

# Styled blocks: https://squidfunk.github.io/mkdocs-material/reference/admonitions/#supported-types
markdown_extensions:
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - smarty


extra_css:
  - assets/custom.css

extra_javascript:
  - assets/fontawesome.min.js
  - assets/solid.min.js

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/MiBiPreT/mibipret