mkdocs.yml

site_name: Perfect Media Server
site_url: https://perfectmediaserver.com
repo_url: https://github.com/IronicBadger/pms-wiki
repo_name: ironicbadger/pms-wiki
edit_uri: edit/main/docs/

theme:
  name: material
  custom_dir: overrides
  language: en
  favicon: images/assets/favicon.png
  icon:
    repo: fontawesome/brands/github
    logo: fontawesome/regular/folder-open
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      accent: teal
      primary: deep orange
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    code: Jet Brains Mono
  features:
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.sections # prevents collapsible sections
    - navigation.indexes # section index pages
    #- navigation.expand #expands sections by default
    #- navigation.tabs # section tabs along the top
    - toc.follow
    - toc.integrate # moves toc to the left
  # insiders only
    - navigation.path # breadcrumbs at the top of each page
    - search.suggest
plugins:
  - blog:
      categories: false
      archive: false
  #- git-revision-date
  - search
  - minify:
      minify_html: true
  - privacy:
      links_attr_map:
        target: _blank
  - social:
      cards_layout: default
markdown_extensions:
  - admonition # enables coloured blocks mid article
  - attr_list # improves image handling
  - md_in_html # grids (insiders)
  - pymdownx.details # enables collapsible admonitions
  - footnotes
  - toc:
      permalink: true
      toc_depth: 4
  - abbr # enables glossary
  - pymdownx.snippets: # enables glossary
      auto_append:
        - overrides/glossary.md
  - pymdownx.keys # display keyboard commands nicely ++ctrl+alt+del++
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true 
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
copyright: 2020 - 2024 © Alex Kretzschmar - This work is licensed under CC BY-NC-SA 4.0
extra_css:
  - extra.css
extra:
  social:
    - icon: 'fontawesome/brands/github'
      link: 'https://github.com/ironicbadger'
      name: IronicBadger on GitHub
    - icon: 'fontawesome/brands/mastodon'
      link: 'https://techhub.social/@ironicbadger'
      name: IronicBadger on Mastodon
    - icon: 'fontawesome/brands/linkedin'
      link: 'https://www.linkedin.com/in/alex-kretzschmar/'
    - icon: 'fontawesome/brands/twitter'
      link: 'https://twitter.com/ironicbadger'
      name: IronicBadger on Twitter
    - icon: 'fontawesome/solid/microphone'
      link: 'https://selfhosted.show/'
      name: Alex's Podcast - selfhosted.show
  analytics:
    # provider: plausible
    # property: perfectmediaserver.com
    provider: google
    property: G-DF6SGTVVBC
nav:
  - News and Updates: blog/index.md
  - 1. Overview:
    - 'index.md'
    - Getting Started: '01-overview/index.md'
    - Alex's PMS Example Build: '01-overview/alexs-example-builds.md'
    #- NAS Software Comparison: '01-overview/nas-software-comparison.md'
    - FAQs: '01-overview/faq.md'  
  - 2. Tech Stack Explained:
    - '02-tech-stack/os/index.md'
    #- Operating Systems:  
    #- Linux: '02-tech-stack/os/index.md'
    - Proxmox: '02-tech-stack/proxmox.md'
    - NixOS: '02-tech-stack/nixos.md'
    - Data and Storage:
      - mergerfs: '02-tech-stack/mergerfs.md'
      - SnapRAID: '02-tech-stack/snapraid.md'
      - ZFS: '02-tech-stack/zfs.md'
    - Containers:
      - docker: '02-tech-stack/docker.md'
      - docker-compose: '02-tech-stack/docker-compose.md'
      - podman: '02-tech-stack/podman.md'
  - 3. Installation:
    - '03-installation/index.md'
    - Proxmox: '03-installation/manual-install-proxmox.md'
    #- NixOS: '03-installation/nixos-flake.md'
    #- Video Install on Proxmox: '03-installation/video-install-proxmox.md'
    # - NixOS:
    #   - Easy Mode (no Flakes): '03-installation/nixos-noflake.md'
    #   - Hard Mode (using Flakes): '03-installation/nixos-flake.md'
      #- Video Install on NixOS: '03-installation/video-install-nixos.md'
    - Manual Install on Ubuntu: '03-installation/manual-install-ubuntu.md'
            
  - 4. Day Two (Post Install):
    - Remote Access:
      - Reverse Proxies: 
        - '04-day-two/remote-access/index.md'
        - Traefik 101 Guide: '04-day-two/remote-access/traefik101.md'
      - VPNs: '04-day-two/remote-access/vpns.md'
    - Top 10 Self-Hosted Apps: '04-day-two/top10apps.md'
    - Backups: '04-day-two/backups.md'
  - 5. Advanced Topics: 
    - Infrastructure as Code: '05-advanced/infraascode.md'
    - Using ZFS with mergerfs: '05-advanced/combine-zfs-and-others.md'
    - Quick Sync and iGPU passthrough: '05-advanced/passthrough-igpu-gvtg.md'
  - 6. Hardware:
    - Intel QuickSync: '06-hardware/intel-quicksync.md'
    - Cases: '06-hardware/cases.md'
    - Storage:
      - New Drive Burn-In Rituals: '06-hardware/new-drive-burnin.md'
      - HDD Purchase Methodology: '06-hardware/hdd-purchase-methodology.md'