mkdocs.yml

site_name: Prohelion Documentation
site_url: https://docs.prohelion.com

extra_css:
  - assets/stylesheets/theme.css

theme:
  name: material
  custom_dir: docs/Overrides  
  logo: assets/images/Prohelion_Logo_32.png
  favicon: assets/favicon.ico
  features:
    - navigation.tracking
    - navigation.tabs
    - navigation.path
    - navigation.indexes
    - navigation.top
    - toc.integrate
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.footnote.tooltips
    - navigation.footer
  palette:
    scheme: default
    primary: black
    accent: red

copyright: >
  Copyright © 2016 - 2026 Prohelion Pty Ltd

plugins:
  - search
  - awesome-pages
  - offline
  # - with-pdf
  - spellcheck:
      backends:  # the backends you want to use
      - symspellpy

      # known_words can also be a list of words
      known_words: known_words.txt

      # ignore words in <code> tags
      ignore_code: yes

      # minimum length of words to consider
      min_length: 2

      # keep unicode characters
      allow_unicode: no

      # whether to only check in strict mode
      strict_only: no

      skip_files:
      - Battery_Management_Systems/Prohelion_BMS_D1000_Gen2/Firmware/V1.2/Configuration_Parameters.md
      - Battery_Management_Systems/Prohelion_BMS_D1000_Gen2/Firmware/V1.2/Messages_and_Signals.md


  - glightbox:
      touchNavigation: true
      loop: false
      effect: zoom
      slide_effect: slide
      width: 100%
      height: auto
      zoomable: true
      draggable: true
      skip_classes:
        - custom-skip-class-name
      auto_caption: true
      caption_position: bottom
      background: white
      shadow: true

  - redirects:
      redirect_maps:
        'Battery_Management_System/index.md': 'Battery_Management_Systems/index.md'
        'Battery_Management_System/1000V_BMS_Gen1/index.md': 'Battery_Management_Systems/Prohelion_BMS_D1000_Gen1/index.md'
        'Battery_Management_System/48V_BMU_User_Manual/index.md': 'Battery_Management_Systems/Prohelion_BMS_M48_Gen1/index.md'

markdown_extensions:    
  - pymdownx.superfences
  - tables  
  - attr_list
  - md_in_html
  - admonition
  - footnotes
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg  
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tabbed:
      alternate_style: true

extra:
  homepage: https://docs.prohelion.com
  generator: false
  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.
    actions:
      - accept
      - manage
  analytics:
    provider: google
    property: G-FPHZWP3H2R
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >- 
            Thanks for your feedback! Help us improve this page by
            using our <a href="https://github.com/Prohelion/prohelion.github.io/issues/new/?title=[Feedback]+{title}+-+{url}" target="_blank" rel="noopener">feedback form</a>.