esphome-docs/hugo.yaml

baseURL: ""
languageCode: en-us
title: ESPHome - Smart Home Made Simple
theme: esphome-theme
enableGitInfo: true

security:
  funcs:
    getenv: ['^HUGO_', '^CI$', 'NETLIFY', 'REPOSITORY_URL', 'BRANCH', 'COMMIT_REF']

params:
  description: ESPHome - Smart Home Made Simple. ESPHome turns ESP32, ESP8266, and RP2040 microcontrollers into fully-featured smart home devices.
  images:
    - logo.svg
  api_docs_url: https://api-docs.esphome.io
  math: true


  # Social media links
  social:
    - name: GitHub
      url: https://github.com/esphome/esphome
    - name: Discord
      url: https://discord.gg/KhAMKrd
    - name: Forums
      url: https://community.home-assistant.io/c/esphome/

menu:
  main:
    - name: "Getting Started"
      weight: 10
      identifier: "getting-started"
    - name: "From Home Assistant"
      url: "/guides/getting_started_hassio/"
      weight: 11
      parent: "getting-started"
    - name: "Using Command Line"
      url: "/guides/getting_started_command_line/"
      weight: 12
      parent: "getting-started"
    - name: "Ready-Made Projects"
      url: "/projects/"
      weight: 13
      parent: "getting-started"
    - name: "Migrate from Tasmota"
      url: "/guides/migrate_sonoff_tasmota/"
      weight: 14
      parent: "getting-started"
    - name: "FAQ and Tips"
      url: "/guides/faq/"
      weight: 15
      parent: "getting-started"

    - name: "Next Steps"
      weight: 20
      identifier: "next-steps"
    - name: "Documentation"
      url: "/components/"
      weight: 21
      parent: "next-steps"
    - name: "Automations"
      url: "/automations/"
      weight: 22
      parent: "next-steps"
    - name: "Configuration Types"
      url: "/guides/configuration-types/"
      weight: 23
      parent: "next-steps"
    - name: "Device Examples"
      url: "https://devices.esphome.io/"
      weight: 24
      parent: "next-steps"
    - name: "DIY Examples"
      url: "/guides/diy/"
      weight: 25
      parent: "next-steps"
    - name: "Sharing ESPHome Devices"
      url: "/guides/creators/"
      weight: 26
      parent: "next-steps"
    - name: "Made for ESPHome"
      url: "/guides/made_for_esphome/"
      weight: 27
      parent: "next-steps"

    - name: "Keeping Up"
      weight: 30
      identifier: "keeping-up"
    - name: "Changelog"
      url: "/changelog/"
      weight: 31
      parent: "keeping-up"
    - name: "Discord"
      url: "https://discord.gg/KhAMKrd"
      weight: 32
      parent: "keeping-up"
    - name: "Forums"
      url: "https://community.home-assistant.io/c/esphome/"
      weight: 33
      parent: "keeping-up"
    - name: "Development"
      url: "https://developers.esphome.io"
      weight: 34
      parent: "keeping-up"
    - name: "Supporters"
      url: "/guides/supporters/"
      weight: 35
      parent: "keeping-up"
  footer:
    - name: Documentation
      weight: 1
    - { parent: Documentation, url: "components/", post: "puzzle-piece", name: Components}
    - { parent: Documentation, url: "guides/", post: "compass", name: Guides}
    - { parent: Documentation, url: "automations/", post: "magic", name: Automations}
    - { parent: Documentation, url: "cookbook/", post: "kitchen-set", name: Cookbook}

    - name: Community
      weight: 2
    - { parent: Community, url: "https://discord.gg/KhAMKrd", post: "discord", name: Discord}
    - { parent: Community, url: "https://github.com/esphome/esphome", post: "github", name: Github}
    - { parent: Community, url: "https://community.home-assistant.io/c/esphome/", post: "comments", name: Forum}

    - name: Resources
      weight: 1000
    - { parent: Resources, url: "changelog/", post: "history", name: Changelog}
    - { parent: Resources, url: "https://devices.esphome.io", post: "microchip", name: "Device Database"}
    - { parent: Resources, url: "https://developers.esphome.io", post: "code", name: Development}

markup:
  highlight:
    codeFences: true
    guessSyntax: false
    lineNos: false
    noClasses: false
  goldmark:
    renderer:
      unsafe: true  # Allow HTML in markdown files
    extensions:
      footnote: true
  tableOfContents:
    startLevel: 1
    endLevel: 3
    ordered: true


outputs:
  home:
    - HTML
    - RSS
    - ComponentsJSON

# Static file configuration
staticDir:
  - static

mediaTypes:
  image/svg+xml:
    suffixes:
      - svg

outputFormats:
  SVG:
    mediaType: image/svg+xml
    isPlainText: true
    isHTML: false
  ComponentsJSON:
    mediaType: application/json
    baseName: components
    isPlainText: true
    isHTML: false
    path: ""

module:
  mounts:
    - disableWatch: false
      source: static
      target: static
    - disableWatch: false
      source: pagefind
      target: assets/pagefind
    - disableWatch: false
      source: static/images
      target: assets/images
    - disableWatch: true
      source: assets
      target: assets
    - disableWatch: false
      source: pagefind
      target: static/pagefind
    - disableWatch: false
      source: static/images
      target: static/images