docker-documentation/mkdocs.yml at main · linuxserver/docker-documentation · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
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 &copy; 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
            exclude:
              - deprecated_images/*
              - images/*
        - 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
        images/docker-snipe-it.md: deprecated_images/docker-snipe-it.md
        images/docker-freetube.md: deprecated_images/docker-freetube.md
        images/docker-fleet.md: deprecated_images/docker-fleet.md
        general/fleet.md: API.md
        images/docker-emulatorjs.md: deprecated_images/docker-emulatorjs.md
        images/docker-netbootxyz.md: deprecated_images/docker-netbootxyz.md
        images/docker-readarr.md: deprecated_images/docker-readarr.md
        images/docker-sickchill.md: deprecated_images/docker-sickchill.md
        images/docker-pylon.md: deprecated_images/docker-pylon.md
        images/docker-feed2toot.md: deprecated_images/docker-feed2toot.md
        images/docker-steamos.md: deprecated_images/docker-steamos.md
        images/docker-overseerr.md: deprecated_images/docker-overseerr.md