site_name: Home Assistant MCP
site_description: A bridge between Home Assistant and Language Learning Models
site_url: https://jango-blockchained.github.io/advanced-homeassistant-mcp/
repo_url: https://github.com/jango-blockchained/advanced-homeassistant-mcp
repo_name: jango-blockchained/advanced-homeassistant-mcp

theme:
  name: material
  logo: assets/images/logo.png
  favicon: assets/images/favicon.ico
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy

markdown_extensions:
  - admonition
  - attr_list
  - def_list
  - footnotes
  - meta
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

plugins:
  - search
  - git-revision-date-localized:
      type: date
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_source: true

nav:
  - Home: index.md
  - Getting Started:
    - Overview: getting-started.md
    - Installation: getting-started/installation.md
    - Configuration: getting-started/configuration.md
    - Docker Setup: getting-started/docker.md
    - Quick Start: getting-started/quickstart.md
    - Usage: usage.md
  - API Reference:
    - Overview: api/index.md
    - Core API: api.md
    - SSE API: api/sse.md
    - Core Functions: api/core.md
  - Tools:
    - Overview: tools/tools.md
    - Device Management:
      - List Devices: tools/device-management/list-devices.md
      - Device Control: tools/device-management/control.md
    - History & State:
      - History: tools/history-state/history.md
      - Scene Management: tools/history-state/scene.md
    - Automation:
      - Automation Management: tools/automation/automation.md
      - Automation Configuration: tools/automation/automation-config.md
    - Add-ons & Packages:
      - Add-on Management: tools/addons-packages/addon.md
      - Package Management: tools/addons-packages/package.md
    - Notifications:
      - Notify: tools/notifications/notify.md
    - Events:
      - Event Subscription: tools/events/subscribe-events.md
      - SSE Statistics: tools/events/sse-stats.md
  - Development:
    - Overview: development/development.md
    - Best Practices: development/best-practices.md
    - Interfaces: development/interfaces.md
    - Tool Development: development/tools.md
    - Testing Guide: testing.md
  - Architecture: architecture.md
  - Contributing: contributing.md
  - Troubleshooting: troubleshooting.md
  - Examples:
    - Overview: examples/index.md
  - Roadmap: roadmap.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/jango-blockchained/homeassistant-mcp
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/jangoblockchained/homeassistant-mcp
  analytics:
    provider: google
    property: !ENV GOOGLE_ANALYTICS_KEY

extra_css:
  - assets/stylesheets/extra.css

copyright: Copyright © 2024 Jango Blockchained