mkdocs.yml

site_name: University Polling

plugins:
  - termynal
  # - mike:
  #     # These fields are all optional; the defaults are as below...
  #     alias_type: symlink
  #     redirect_template: null
  #     deploy_prefix: ''
  #     canonical_version: null
  #     version_selector: true
  #     css_dir: css
  #     javascript_dir: js

theme: 
  name: material
  logo: assets/logo.svg
  favicon: assets/favicon.ico
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.expand
    - navigation.sections
    - navigation.top
    - navigation.path
    # - toc.integrate
    - toc.follow
    - search.suggest
    - search.highlight
    - content.tabs
    - content.code.annotate
    - content.code.copy
    - navigation.indexes 
  language: en
  palette:
    - scheme: default
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
      primary: deep purple
      accent: deep purple
    - scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to light mode
      primary: deep purple
      accent: deep purple
  icon:
    repo: fontawesome/brands/github

extra:
  # version:
  #   provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/unipoll
  consent:
    title: Cookie consent
    description: >-
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.

# Copyright in the footer
copyright: Copyright © 2023 University Polling

# GitHub repository link in the header
repo_url: https://github.com/unipoll
repo_name: ""

# Markdown extensions
markdown_extensions:
  - tables
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.tasklist
  - attr_list

nav:
  - Home:
    - 'index.md'
    - About: 'about/index.md'
  - API Documentation:
    - 'api-docs/index.md'
    - Usage:
      - 'api-docs/usage/index.md'
      - 'api-docs/usage/Quick Start.md'
      - 'api-docs/usage/Configuration.md'
      - 'api-docs/usage/Deployment.md'
      - 'api-docs/usage/Overview.md'
      - 'api-docs/usage/Permissions.md'
      - 'api-docs/usage/Authentication.md'
      - 'api-docs/usage/OpenAPI.md'
      - 'api-docs/usage/API Reference.md'
    - Development:
      - 'api-docs/development/index.md'
      - 'api-docs/development/Structure.md'
      - 'api-docs/development/Libraries.md'
      - 'api-docs/development/Release.md'
      - 'api-docs/development/Testing.md'
    - Changelog: 'api-docs/CHANGELOG.md'
  - Web App:
    - 'web-app-docs/index.md'
    - Usage:
      - 'web-app-docs/usage/index.md'
      - 'web-app-docs/usage/Quick Start.md'
    - Development:
      - 'web-app-docs/development/index.md'