mkdocs.yml

site_name: WLED Project
site_author: WLED Team
site_url: https://kno.wled.ge
repo_name: WLED
repo_url: https://github.com/wled/WLED
copyright: Copyright © 2016-{year} Christian Schwinne, Contributors
edit_uri: https://github.com/wled/WLED-Docs/edit/main/docs
theme:
  name: material
  custom_dir: docs/assets/overrides
  language: en
  favicon: assets/images/ui/aircoookie/blurple.png
  logo: assets/images/ui/akemi/001_cheerful.png
  icon: 
    repo: fontawesome/brands/github
  features: 
    - navigation.top
    # - navigation.expand
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - content.action.edit
    - content.code.annotate
    - content.code.copy
    - search.suggest
    - search.highlight
    # - toc.integrate
  palette:
    - scheme: slate
      primary: cyan #mostly overridden in extra.css
      accent: orange
      toggle: 
        icon: material/weather-sunny
        name: Light Mode
    - scheme: default
      primary: orange
      accent: orange
      toggle: 
        icon: material/weather-night
        name: Dark Mode
plugins:
  - search
  - redirects:
      redirect_maps:
        advanced/compile-analog.md: advanced/compiling-wled.md
        advanced/compile-wled.md: advanced/compiling-wled.md
        basics/compiling-wled.md: advanced/compiling-wled.md
        interfaces/blynk.md: advanced/home-automation.md
markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.highlight
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tilde
extra:
  social:
    - icon: fontawesome/brands/discord
      link: https://discord.gg/QAh7wJHrRM
      name: Discord
    - icon: fontawesome/brands/discourse
      link: https://wled.discourse.group/
      name: Forum
    - icon: fontawesome/solid/code
      link: https://gitpod.io/#https://github.com/Aircoookie/WLED
      name: Gitpod
    - icon: fontawesome/brands/instagram
      link: https://www.instagram.com/wled_project/
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/results?search_query=WLED
    - icon: fontawesome/solid/shirt
      link: https://wled.teemill.com/
    - icon: fontawesome/solid/heart
      link: https://paypal.me/aircoookie/
  analytics:
    provider: google
    property: G-QSVCRSVM18
extra_css:
  - assets/stylesheets/global.css
  - assets/stylesheets/extra.css
extra_javascript:
  - assets/js/newtab.js
nav:
  - Welcome: index.md
  - Basics:
    - Getting Started: 
      - Quick Start: basics/getting-started.md
      - The Web UI: basics/web-ui.md
      - Wiring Guides: basics/wiring-guides.md
    - Top 5 mistakes: basics/top5_mistakes.md
    - Compatibility:
      - LED strips: basics/compatible-led-strips.md
      - Controllers: basics/compatible-controllers.md
      - Other Hardware: basics/compatible-hardware.md
      - Software: basics/compatible-software.md
    - Installation:
      - Install WLED Binary: basics/install-binary.md
      - Install using ESP GUI: basics/install-gui.md
      - Install using WLED ESP Flasher: basics/install-wled-flasher.md
      - Compiling WLED: advanced/compiling-wled.md
    - Tutorials: basics/tutorials.md
    - FAQ: basics/faq.md
  - Features:
    - Effects: features/effects.md
    - Palettes: features/palettes.md
    - Macros: features/macros.md
    - Presets: features/presets.md
    - Segments: features/segments.md
    - Settings: features/settings.md
    - Multi-strip Support: features/multi-strip.md
    - Relay Control: features/relay-control.md
    - Web GUI Sitemap: features/subpages.md
    - Pin Info: features/pin-info.md
    - White handling: features/cct.md
    - Pixel Art Converter: features/pixel-art-converter.md
    - PixelForge (Image & GIF Tool): features/pixelforge.md
    - Custom Fonts: features/custom-fonts.md
    - Particle System: features/particle-system.md
    - Ethernet (LAN) compatibility: features/ethernet-lan.md
  - Interfaces:
    - DMX Output: interfaces/dmx-output.md
    - DMX Input: interfaces/dmx-input.md
    - E1.31 (DMX) / Art-Net: interfaces/e1.31-dmx.md
    - HTTP Request API: interfaces/http-api.md
    - Remote Control: interfaces/infrared.md
    - JSON API: interfaces/json-api.md
    - MQTT: interfaces/mqtt.md
    - Philips Hue: interfaces/philips-hue.md
    - Serial: interfaces/serial.md
    - WLED UDP Sync: interfaces/udp-notifier.md
    - UDP Realtime / tpm2.net: interfaces/udp-realtime.md
    - Websocket: interfaces/websocket.md
    - DDP Realtime: interfaces/ddp.md
    - ESPNow Remotes: interfaces/espnow.md
  - Advanced:
    - Audio Reactive WLED: advanced/audio-reactive.md
    - Home Automation: advanced/home-automation.md
    - Remote Access / IFTTT: advanced/remote-access-ifttt.md
    - OTA Lock: advanced/ota-lock.md
    - Accessing WLED over Internet: advanced/access-over-internet.md
    - Wiring Protips: advanced/wiring.md
    - Long Data Lines: advanced/longdata.md
    - Compiling WLED: advanced/compiling-wled.md
    - Custom Features: advanced/custom-features.md
    - Community Usermods: advanced/community-usermods.md
    - ESP32 Recovery: advanced/esp32-recovery.md
    - Boot-loop Detection & Recovery: advanced/bootloop-recovery.md
    - HUB75: advanced/HUB75.md
    - Mapping: advanced/mapping.md
    - Mixed 2D and 1D Bus: advanced/2d-1d-Mixed-Setup.md
    - Virtual LEDs: advanced/ddp.md
    - Custom Access Point Configuration: advanced/custom-ap.md
    - Using PIR Sensors: advanced/pir-sensors.md
  - About: 
    - Contributors & Credits: about/contributors.md
    - Privacy Policy: about/privacy-policy.md
    - Upcoming Features: about/roadmap.md
    - Historical Features: about/historical-features.md