mkdocs.yml

site_name: LinuxServer.io
site_url: https://docs.linuxserver.io
site_author: LinuxServer.io
site_description: Welcome to the home of the LinuxServer.io documentation!
repo_name: linuxserver/docker-documentation
repo_url: https://github.com/linuxserver/docker-documentation
copyright: Copyright © 2025 LinuxServer.io
theme:
  name: material
  features:
    # - content.action.edit
    - content.code.copy
    - navigation.footer
    # - navigation.instant
    # - navigation.prune
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: purple
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: purple
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  favicon: assets/favicon.ico
  logo: assets/icon.svg
extra:
  social:
    - icon: fontawesome/solid/otter
      link: https://linuxserver.io
    - icon: fontawesome/brands/discord
      link: https://linuxserver.io/discord
    - icon: fontawesome/brands/discourse
      link: https://discourse.linuxserver.io
    - icon: fontawesome/brands/github
      link: https://github.com/linuxserver
    - icon: fontawesome/brands/gitlab
      link: https://gitlab.com/linuxserver.io
    - icon: fontawesome/brands/mastodon
      link: https://mastodon.linuxserver.io/@linuxserver
    - icon: fontawesome/brands/bluesky
      link: https://bsky.app/profile/linuxserver.io
extra_css:
  - stylesheets/extra.css
extra_javascript:
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - javascripts/tablesort.js
markdown_extensions:
  - pymdownx.tabbed:
      combine_header_slug: true
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - admonition
  - pymdownx.details
  - pymdownx.escapeall
  - pymdownx.extra
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - tables
  - toc:
      permalink: true
plugins:
  - awesome-pages
  - d2:
      layout: elk
      pad: 0
      theme: 3
      dark_theme: 200
  - group:
      enabled: !ENV CI
      plugins:
        - git-revision-date-localized:
            enable_creation_date: true
        - minify:
            minify_html: true
  - render_swagger
  - search
  - tags:
      tags: false
  - redirects:
      redirect_maps:
        "faq.md": "FAQ.md"
        general/awesome-lsio.md: images-by-category.md
        misc/awesome-lsio.md: images-by-category.md
        images/docker-readme-sync.md: deprecated_images/docker-readme-sync.md
        images/docker-unifi-controller.md: deprecated_images/docker-unifi-controller.md
        images/docker-dillinger.md: deprecated_images/docker-dillinger.md
        images/docker-endlessh.md: deprecated_images/docker-endlessh.md
        images/docker-plex-meta-manager.md: deprecated_images/docker-plex-meta-manager.md
        deprecated_images/docker-nzbget.md: images/docker-nzbget.md
        images/docker-booksonic-air.md: deprecated_images/docker-booksonic-air.md
        images/docker-quassel-core.md: deprecated_images/docker-quassel-core.md
        images/docker-quassel-web.md: deprecated_images/docker-quassel-web.md
        images/docker-daapd.md: deprecated_images/docker-daapd.md
        images/docker-domoticz.md: deprecated_images/docker-domoticz.md
        images/docker-embystat.md: deprecated_images/docker-embystat.md
        images/docker-headphones.md: deprecated_images/docker-headphones.md
        images/docker-doc-builder.md: deprecated_images/docker-doc-builder.md
        images/docker-nano-wallet.md: deprecated_images/docker-nano-wallet.md
        images/docker-nano.md: deprecated_images/docker-nano.md
        images/docker-minetest.md: deprecated_images/docker-minetest.md
        images/docker-snapdrop.md: deprecated_images/docker-snapdrop.md