mkdocs.yml

site_name: ShadyF's K8s Homelab
site_description: The documentation website of my kubernetes (k3s) homelab cluster

# Repo details
repo_url: https://github.com/ShadyF/k8s-homelab
repo_name: ShadyF/k8s-homelab

# Hide edit button on pages
edit_uri: ""

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      accent: deep orange
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: deep orange
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  logo: https://raw.githubusercontent.com/ShadyF/shadyf.github.io/master/favicon.ico
  favicon: https://raw.githubusercontent.com/ShadyF/shadyf.github.io/master/favicon.ico
  features:
    - navigation.instant
    - navigation.top
#    - navigation.tabs

extra:
  # https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer/?h=social#configuration
  social:
    - icon: fontawesome/solid/globe
      link: https://shadyf.com
    - icon: fontawesome/brands/github
      link: https://github.com/shadyf
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/ssfanous/
    - icon: fontawesome/solid/paper-plane
      link: mailto:sssfanous@gmail.com
  analytics:
    provider: google
    property: G-EYY1E6KXTP

copyright: Copyright © 2021 - 2022 Shady Fanous


plugins:
  - search

extra_css:
  - _static/custom.css

markdown_extensions:
  # Ability to add Abbreviations
  - abbr
  # Ability to add admonitions
  - admonition
  # Ability to add definition lists
  - def_list
  # Ability to add footnotes (https://squidfunk.github.io/mkdocs-material/reference/footnotes/)
  - footnotes
  - toc:
      permalink: "#"
  - meta
  # allows to add HTML attributes and CSS classes to Markdown elements (https://squidfunk.github.io/mkdocs-material/reference/images/)
  - attr_list
  # Use for code highlighting (https://squidfunk.github.io/mkdocs-material/reference/code-blocks/)
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.inlinehilite
  # Extension to make and style keypresses (https://facelessuser.github.io/pymdown-extensions/extensions/keys/)
  - pymdownx.keys
  # Ability to add tabs (https://squidfunk.github.io/mkdocs-material/reference/content-tabs/)
  - pymdownx.tabbed
  # Ability to make admonitions collapsible
  - pymdownx.details

  # Bunch of formatting extensions
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  # SmartSymbols (https://facelessuser.github.io/pymdown-extensions/extensions/smartsymbols/)
  - pymdownx.smartsymbols

  # Add emojis
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg

      # Tasks use a custom checkbox (https://facelessuser.github.io/pymdown-extensions/extensions/tasklist/)
  - pymdownx.tasklist:
      custom_checkbox: true

nav:
  - Introduction: 'index.md'
  - Cluster Setup:
      - Setting up Raspberry Pi for k3s: 'cluster_setup/setting_up_raspberry_pi.md'
      - Installing k3s: 'cluster_setup/installing_k3s.md'
      - Setting up Flux: 'cluster_setup/setting_up_flux.md'
  #      - Adding SOPS support to Flux: 'cluster_setup/adding_sops_support_to_flux.md'
  - Apps: 'apps/oauth2-proxy.md'
  - Miscellaneous:
      - Restrict Port Forwarding to only allow Cloudflare IPs using OpenWRT: 'miscellaneous/cloudflare_port_forwarding_openwrt.md'
      - Cloudflare DDNS not working with OpenWRT based routers: 'miscellaneous/cloudflare_ddns_not_working_with_openwrt.md'
      - Enabling Wake on Lan on NIC: 'miscellaneous/enabling_WakeOnLan_on_NIC.md'
      - Getting MetalLB to work on Raspberry Pi 4's Wifi: 'miscellaneous/metallb_not_working_raspberry_wifi.md'
      - Tips and Tricks: 'miscellaneous/tips_and_tricks.md'