mkdocs.yml

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

theme:
  name: material
  language: en
  #logo: images/site/logo.png
  favicon: images/assets/favicon.png
  icon:
    repo: fontawesome/brands/github
    logo: fontawesome/regular/folder-open
  palette:
    primary: blue
    accent: teal
    scheme: default
  font:
    code: Jet Brains Mono
  features:
    - navigation.instant
    #- navigation.sections # prevents collapsible sections
    #- navigation.expand #expands sections by default
  # insiders only
  #   - search.suggest

google_analytics: ['UA-17919826-9', 'auto']

plugins:
  - git-revision-date
  - search
  - minify:
      minify_html: true
markdown_extensions:
  - abbr
  - admonition # enables coloured blocks mid article
  - attr_list # improves image handling
  - pymdownx.details # enables collapsible admonitions
  - footnotes
  - meta # adds support for front matter
  - toc:
      permalink: true
      toc_depth: 4
  - pymdownx.highlight: # code highlighting
      linenums: true
  - pymdownx.tabbed # enables tabs for embedded blocks
  - pymdownx.snippets
  - pymdownx.superfences # allows for the nesting of code blocks inside other blocks
  - pymdownx.keys

copyright: 2020 - 2021 © Alex Kretzschmar - Licensed under GPLv3
extra:
  social:
    - icon: 'fontawesome/brands/github'
      link: 'https://github.com/ironicbadger'
      name: IronicBadger on GitHub
    - icon: 'fontawesome/brands/twitter'
      link: 'https://twitter.com/ironicbadger'
      name: IronicBadger on Twitter
    - icon: 'fontawesome/brands/linkedin'
      link: 'https://www.linkedin.com/in/alex-kretzschmar/'      
    - icon: 'fontawesome/solid/microphone'
      link: 'https://selfhosted.show/'
      name: IronicBadger's Podcast - selfhosted.show

nav:
  - Welcome: 'index.md'
  - Overview:
    - Overview & FAQ: 'overview/overview.md'
    - NAS Software Comparison: 'overview/nas-software-comparison.md'
  - Tech Stack:
    - Linux: 'tech-stack/linux.md'
    - Containers:
      - Docker: 'tech-stack/docker.md'
      - docker-compose: 'tech-stack/docker-compose.md'
    - MergerFS: 'tech-stack/mergerfs.md'
    - SnapRAID: 'tech-stack/snapraid.md'
    - ZFS: 'tech-stack/zfs.md'
    - Proxmox: 'tech-stack/proxmox.md'
  - Hardware:
    - Cases: 'hardware/cases.md'
    - HDD Purchase Methodology: 'hardware/hdd-purchase-methodology.md'
    - New Drive Burn-In Rituals: 'hardware/new-drive-burnin.md'
  - Installation:
    - Manual Install on Bare Metal: 'installation/manual-install.md'
    - Manual Install on Video: 'installation/manual-install-on-video.md'
    - Automated Install: 'installation/automated-install.md'
    #- Post Install Checklist: 'installation/post-install-checklist.md'
  - Day Two (Post Install):
    - Top 10 Self-Hosted Apps: 'day-two/top10apps.md'
    - Backups: 'day-two/backups.md'
    - Quality of Life Tweaks: 'day-two/quality-of-life-tweaks.md'
  - Remote Access: 
    - Overview: 'remote-access/remote-access-overview.md'
    - SSH (Secure Shell): 'remote-access/ssh.md'
    - WireGuard: 'remote-access/wireguard.md'
  - Advanced Concepts:
    - Infrastructure as Code: 'concepts/infraascode.md'
    - Hypervisors: 'concepts/hypervisors.md'
    - PCI Passthrough: 'concepts/pci-passthrough.md'
  - Advanced Configuration:
    - Using ZFS with MergerFS: 'advanced/combine-zfs-and-others.md'
    - Quick Sync and Proxmox passthrough: 'advanced/passthrough-igpu-gvtg.md'
  #- Related Projects:
    #- Virtualised OPNsense router: 'related-projects/virtualised-opnsense-proxmox.md'