mkdocs.yml

site_name: dnsweaver
site_url: https://maxfield-allison.github.io/dnsweaver/
site_description: Automatic DNS management for Docker, Kubernetes, and Proxmox VE workloads — multi-provider, split-horizon, and platform-agnostic
site_author: Maxfield Allison

repo_name: maxfield-allison/dnsweaver
repo_url: https://github.com/maxfield-allison/dnsweaver
edit_uri: edit/main/docs/

copyright: |
  Copyright © 2024-2026 Maxfield Allison –
  <a href="#__consent">Cookie settings</a>

theme:
  name: material
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue grey
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: blue grey
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.copy
    - content.code.annotate
    - content.tooltips
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.progress
    - navigation.path
    - navigation.prune
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
  icon:
    repo: fontawesome/brands/github
  logo: assets/logo.svg
  # favicon uses Material theme default

extra_javascript:
  - assets/javascripts/mermaid-init.js

extra:
  generator: false
  status:
    new: Recently added
    deprecated: Deprecated
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/maxfield-allison/dnsweaver
      name: dnsweaver on GitHub
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/maxamill/dnsweaver
      name: dnsweaver on Docker Hub

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.betterem
  - 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
      use_pygments: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - 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:
      separator: '[\s\-\.\_]+'
  - social

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Configuration:
      - configuration/index.md
      - Environment Variables: configuration/environment.md
      - Domain Matching: configuration/domains.md
      - Operational Modes: configuration/modes.md
      - Secrets Management: configuration/secrets.md
      - Multi-Instance: configuration/multi-instance.md
  - Providers:
      - providers/index.md
      - Technitium: providers/technitium.md
      - Cloudflare: providers/cloudflare.md
      - RFC 2136: providers/rfc2136.md
      - Pi-hole: providers/pihole.md
      - AdGuard Home: providers/adguard.md
      - dnsmasq: providers/dnsmasq.md
      - Webhook: providers/webhook.md
  - Sources:
      - sources/index.md
      - Docker Labels: sources/docker.md
      - Docker Swarm: sources/swarm.md
      - Traefik Files: sources/traefik-files.md
      - Caddy Labels: sources/caddy.md
      - nginx-proxy Labels: sources/nginx-proxy.md
      - Native Labels: sources/native-labels.md
      - Kubernetes: sources/kubernetes.md
      - Proxmox VE: sources/proxmox.md
  - Deployment:
      - deployment/index.md
      - Docker Compose: deployment/docker-compose.md
      - Docker Swarm: deployment/swarm.md
      - Kubernetes: deployment/kubernetes.md
      - Split-Horizon DNS: deployment/split-horizon.md
      - Dual-Stack (IPv4/IPv6): deployment/dual-stack.md
  - Observability: observability.md
  - FAQ: faq.md
  - Testing:
      - testing/README.md
      - Test Cases: testing/TEST-CASES.md
      - Release Checklist: testing/RELEASE-CHECKLIST.md
  - Contributing:
      - contributing/index.md
      - Development Setup: contributing/development.md
      - Architecture: contributing/architecture.md
      - Adding a Provider: contributing/adding-provider.md
      - Adding a Source: contributing/adding-source.md