mkdocs.yml

edit_uri: https://github.com/schlimmchen/OpenDTU-OnBattery-docs/edit/main/docs/

repo_url: https://github.com/helgeerbe/OpenDTU-OnBattery
repo_name: OpenDTU-OnBattery

site_name: OpenDTU-OnBattery Documentation
site_description: Software for ESP32 to talk to Hoymiles Inverters and battery peripherals
site_author: "OpenDTU Community"
copyright: '&copy; 2024 OpenDTU Community &ndash; based on <a href="https://opendtu.solar" target="_blank">OpenDTU</a>'

extra:
  social:
    - icon: material/github
      link: https://github.com/helgeerbe/OpenDTU-OnBattery/discussions
      name: GitHub Discussions
    - icon: fontawesome/brands/discord
      link: https://discord.gg/WzhxEY62mB
      name: Discord Chat

theme:
  logo: assets/images/logo.png
  favicon: favicon.ico
  name: material
  language: en
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/link
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/toggle-switch-off
        name: Switch to system preference

  features:
    ## Setting up navigation
    - navigation.instant
    - navigation.tracking
    - navigation.path
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - toc.follow
    ## Search
    - navigation.path
    - search.suggest
    ## Content tabs
    - content.tooltips
    - content.action.edit
    - content.action.view

extra_javascript:
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - assets/javascript/tablesort.js

plugins:
  - search
  - glightbox
  - git-revision-date-localized:
      type: datetime
      timezone: Europe/Berlin
      enable_creation_date: true

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

# Page tree
nav:
  - Home:
      - Introduction: index.md
      - Hardware Support: hardware/index.md
      - Firmware Installation: firmware/index.md
      - Troubleshooting: troubleshooting.md
      - Frequently Asked Questions: firmware/faq.md
  - Hardware:
      - hardware/index.md
      - hardware/inverter_overview.md
      - ESP32 Modules:
        - hardware/recommendations.md
        - hardware/esp32s3_devkit.md
        - hardware/esp32nodemcu_38pin.md
        - hardware/olimexpoeiso.md
      - RF Modules:
        - hardware/nrf24l01plus.md
        - hardware/cmt2300a.md
      - hardware/display.md
      - Limitations: hardware/limitations.md
      - Victron Charge Controllers: hardware/victron_charge_controllers.md
      - VE.Direct: hardware/vedirect.md
      - Batteries:
        - JK BMS:
          - hardware/jkbms/index.md
          - "JK-B* Models": hardware/jkbms/models_b.md
          - "JK-PB* Models": hardware/jkbms/models_pb.md
  - Firmware:
    - Installation:
      - firmware/index.md
      - firmware/flash_esp.md
      - firmware/webinstall.md
    - firmware/wifi_setup.md
    - Dynamic Power Limiter:
      - firmware/dpl.md
      - firmware/solar_passthrough.md
    - Battery Interface: firmware/battery_interface.md
    - Web UI:
      - firmware/configuration/login.md
      - Live View:
        - firmware/configuration/live_view.md
        - firmware/configuration/live_view_info.md
        - firmware/configuration/live_view_eventlog.md
        - firmware/configuration/live_view_power.md
        - firmware/configuration/live_view_limit.md
        - firmware/configuration/live_view_gridprofile.md
      - Settings:
        - firmware/configuration/network_settings.md
        - firmware/configuration/ntp_settings.md
        - firmware/configuration/mqtt_settings.md
        - firmware/configuration/inverter_settings.md
        - firmware/configuration/security_settings.md
        - firmware/configuration/dtu_settings.md
        - firmware/configuration/device_settings.md
        - firmware/configuration/dpl.md
        - Battery:
          - firmware/configuration/battery_settings.md
          - firmware/configuration/battery_settings_jkbms.md
          - firmware/configuration/battery_settings_mqtt.md
        - firmware/configuration/config_settings.md
        - firmware/configuration/firmware_upgrade.md
        - firmware/configuration/device_reboot.md
      - Info:
        - firmware/configuration/system_info.md
        - firmware/configuration/network_info.md
        - firmware/configuration/ntp_info.md
        - firmware/configuration/mqtt_info.md
        - firmware/configuration/console.md
      - firmware/configuration/about.md
    - firmware/update.md
    - firmware/device_profiles.md
    - firmware/mqtt_topics.md
    - firmware/web_api.md
    - Howtos:
      - firmware/howto/serial_console.md
      - firmware/howto/migrate_generic.md
      - firmware/howto/upgrade_8mb.md
      - firmware/howto/upgrade_upstream.md
    - Compiling:
      - firmware/compile_vscode.md
      - firmware/compile_cli.md
      - firmware/compile_webapp.md
    - License: license.md
  - 3rd Party:
      - 3rd_party/opendtu_fusion.md
      - 3rd_party/related.md
      - 3rd_party/cases.md
      - 3rd_party/pcb.md