mkdocs.yml

site_name: Tasmota
site_description: Documentation (Wiki) for Tasmota
site_url: https://tasmota.github.io/docs/
repo_name: 'arendst/tasmota'
repo_url: 'https://github.com/arendst/tasmota'
edit_uri: 'https://github.com/tasmota/docs/blob/master/docs/'
docs_dir: docs
# copyright: 'Copyright © 2020 Tasmota Development Team'

plugins:
  - search:
      lang:
        - de
        - en
  - alternate-link
  - minify:
      minify_html: true
  - redirects:
      redirect_maps:
        'GPIO-Locations.md': 'Pinouts.md'
        'BMP280.md': 'BME280.md'
        'Rule-Cookbook.md': 'Rules.md'
        'Sensor-Configuration.md': 'Peripherals.md'
        'Scripting-Cookbook.md': 'Scripting-Language.md'
        'Status-LED.md': 'Lights.md'
        'Tuya-Protocols.md': 'TuyaMCU.md'
        'Upgrade.md': 'Upgrading.md'
        'Berry-Scripting.md': 'Berry.md'
  - gen-files:
      scripts:
        - scripts/timezone_table.py
# - htmlproofer

# strict: true

theme:
  name: material
  language: 'en'
  # custom_dir: 'overrides'
  logo: '_media/logo.svg'
  favicon: _media/favicon.ico
  palette:

    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue
      accent: indigo
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode

    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue
      accent: deep purple
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.instant
    - navigation.top
    - navigation.tracking
  font:
    text: Barlow
    code: Roboto Mono

extra:
  social:
    - icon: fontawesome/brands/discord
      link: 'https://discord.gg/Ks2Kzd4'
    - icon: fontawesome/brands/telegram
      link: 'https://t.me/tasmota'
    - icon: fontawesome/brands/github-alt
      link: 'https://github.com/tasmota'
  analytics:
    provider: google
    property: G-8J08F8X90S

markdown_extensions:
  - admonition
  - toc:
     permalink: "~"
     toc_depth: 3
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.betterem
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.highlight
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.superfences
  - pymdownx.snippets
  - pymdownx.tilde
  - meta
  - def_list
  - attr_list
  - md_in_html

extra_css:
  - 'assets/css/anchor-fix.css'

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

nav:
  - Home:
    - News: index.md
    - About.md
    - Getting Started: Getting-Started.md
    - Upgrading.md
    - MQTT.md
    - Commands: Commands.md
    - Templates: Templates.md
    - Components.md
    - Modules: Modules.md
    - Peripherals: Peripherals.md
    - WebUI.md
    - Firmware-Builds.md
    - Compiling: Compile-your-build.md
    - Contributing: Contributing.md
    - Download.md
    - Project Showcase: "https://github.com/arendst/Tasmota/discussions/categories/show-and-tell"
  - Features:
    - Introduction: Features.md
    - Analog pin: ADC.md
    - Bluetooth.md
    - Buttons-and-Switches.md
    - DeepSleep.md
    - Device-Groups.md
    - Displays.md
    - Dynamic-Sleep.md
    - I2C Devices: I2CDEVICES.md
    - IR Communication: Tasmota-IR.md
    - LCD/DLP Projector Control: Projector.md
    - Lights.md
    - OpenTherm: OpenTherm.md
    - PIR-Motion-Sensors.md
    - Power-Monitoring-Calibration.md
    - PWM-dimmer-switch.md
    - RF Communication: RF-Protocol.md
    - Rules.md
    - Scripting: Scripting-Language.md
    - Safeboot.md
    - Serial-to-TCP-Bridge.md
    - Blinds-and-Shutters.md
    - Range-Extender.md
    - Smart-Meter-Interface.md
    - Subscribe-&-Unsubscribe.md
    - TasmotaClient.md
    - Thermostat.md
    - Timers.md
    - TLS.md
    - TuyaMCU.md
    - Universal File System: UFS.md
    - Zigbee.md
    - Projects and Tutorials: Tutorials.md
    - For Developers: For-Developers.md
  - ESP32:
    - Tasmota32 Features: ESP32.md
    - Berry: Berry.md
    - Bluetooth Low Energy: Bluetooth_ESP32.md
    - LVGL: LVGL.md
    - HASPmota: HASPmota.md
    - Touch GPIOs: TouchPin.md
    - Supported Devices: "https://templates.blakadder.com/esp32"
  - Smart Home Integrations:
    - Introduction: Integrations.md
    - Alexa.md
    - AWS-IoT.md
    - Domoticz.md
    - Home-Assistant.md
    - Homebridge.md
    - HomeSeer.md
    - IP-Symcon.md
    - KNX.md
    - NodeRed.md
    - nymea.md
    - Octoprint.md
    - openHAB.md
    - otto.md
    - IOBroker: "https://github.com/arendst/Tasmota/issues/3769"
    - Mozilla WebThings Adapter: "https://github.com/tim-hellhake/tasmota-adapter"
    - SmartThings: "https://github.com/hongtat/tasmota-connect"
    - Tasmohab: "https://github.com/Gifford47/tasmohab/blob/master/README.md"
  - Peripherals:
    - Supported-Peripherals.md
    - Buzzer.md
    - A4988 stepper motor controller: A4988-Stepper-Motor-Controller.md
    - AHT1x.md
    - AM2301 temperature and humidity sensor: AM2301.md
    - APDS-9960.md
    - AS3935.md
    - AZ-7798.md
    - BH1750.md
    - BME280.md
    - BME680.md
    - CC2530.md
    - Chirp! moisture sensor: Moisture-Sensor-and-Chirp!-Sensor.md
    - DFR0299.md
    - DHT11.md
    - DS18x20.md
    - DS3231.md
    - EZO.md
    - HM-10.md
    - HM-17.md
    - HC-SR04.md
    - HRG15.md
    - Honeywell-HIH.md
    - IAQ.md
    - IR-Remote.md
    - LM75AD.md
    - MCP230xx.md
    - MFRC522.md
    - MGC3130.md
    - MH-Z19B.md
    - MLX90614.md
    - MLX90640.md
    - MPR121.md
    - MPU-6050.md
    - NRF24L01.md
    - OpenTherm.md
    - P1-Smart-Meter.md
    - PAJ7620.md
    - PCA9685.md
    - PN532.md
    - PZEM-0XX.md
    - RCWL-0516.md
    - RDM6300.md
    - RF-Transceiver.md
    - SDS011.md
    - SHT30.md
    - SK6812.md
    - Smart-Meter-Interface.md
    - SolaX-X1.md
    - SPS30.md
    - TX2x.md
    - TSL2561.md
    - VEML6070.md
    - VEML6075.md
    - VEML7700.md
    - VL53Lxx.md
    - WS2812B-RGB-Shield.md
    - WS2812B-and-WS2813.md
  - Supported Devices:
    - Configure Unknown Device: Configuration-Procedure-for-New-Devices.md
    - All Supported Devices: https://templates.blakadder.com/ "target=_blank"
    - Wi-Fi Module Pinouts: Pinouts.md
    - Supported-Modules.md
  - Help:
    - FAQ.md
    - Troubleshooting.md
    - Device-Recovery.md
    - Discord Support: https://discord.gg/Ks2Kzd4 "target=_blank"
  - Web Installer: "http://tasmota.github.io/install"