HomeLab/mkdocs.yml at main · AyanQuadri/HomeLab · 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
# MkDocs Configuration
site_name: "HomeLab Docs"
site_description: "Documentation for my cybersecurity homelab and self-hosted infrastructure projects"
site_author: "Ayan Quadri"
site_url: "https://AyanQuadri.github.io/HomeLab"

# Repository
repo_name: "HomeLab"
repo_url: "https://github.com/AyanQuadri/HomeLab"
edit_uri: "edit/main/docs/"

# Navigation
nav:
  - Home: index.md
  - Homelab & Networking:
    - Overview: homelab/index.md
    - Proxmox Setup: homelab/proxmox.md
    - Arch Linux VMs: homelab/arch-linux.md
    - File Sharing: homelab/file-sharing.md
    - Network Security: homelab/networking.md
    - Troubleshooting: homelab/troubleshooting.md
    - Performance: homelab/performance.md
  - Self-Hosted Supabase:
    - Overview: supabase/index.md
    - Installation Guide: supabase/installation.md
    - Docker Setup: supabase/docker-setup.md
    - Twingate Security: supabase/twingate.md
    - Access Control: supabase/access-control.md
    - Backup & Recovery: supabase/backup.md
    - Monitoring: supabase/monitoring.md

# Theme
theme:
  name: material
  favicon: assets/HomeLab-logo.png
  logo: assets/HomeLab-logo.png
  custom_dir: docs/overrides
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.footer
    - search.highlight
    - search.share
    - toc.integrate
    - content.code.copy
    - content.code.annotate
  palette:
    # Palette toggle for dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
  font:
    text: JetBrains Mono
    code: Fira Code
  icon:
    logo: material/security
    repo: fontawesome/brands/github

# Plugins
plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - minify:
      minify_html: true

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      # permalink: true
      anchorlink: true
      anchorlink_class: "toclink"
      toc_depth: 2
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - 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

# Extra CSS
extra_css:
  - stylesheets/extra.css
  - stylesheets/extra-timeline.css

# Extra
extra:
  generator: true
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/AyanQuadri
    - icon: fontawesome/brands/linkedin
      link: https://linkedin.com/in/ayan-quadri

copyright: Copyright &copy; 2025 Ayan Quadri