mkdocs.yml

site_name: Truxnell's NixOS homelab
site_author: truxnell
site_url: https://truxnell.github.io/nix-config/

# Repository
repo_name: truxnell/nix-config
repo_url: https://github.com/truxnell/nix-config

docs_dir: ./docs
site_dir: ./site

copyright: Copyright © 2024 Nat Allan

theme:
  name: material
  # custom_dir: ../../docs/overrides
  features:
    - announce.dismiss
    - content.code.annotate
    - content.code.copy
    - navigation.expand
    - navigation.indexes
    - navigation.path
    # - navigation.sections
    - navigation.footer
    # - navigation.tabs
    - navigation.top
    - search.suggest
  palette:
    - scheme: slate
      media: "(prefers-color-scheme: light)"
      primary: black
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      media: "(prefers-color-scheme: dark)"
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  font:
    text: Roboto
    code: Roboto Mono
  icon:
    logo: simple/nixos
    annotations: material/chat-question

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

# Extensions
markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.caret
  - pymdownx.tilde
  - pymdownx.snippets:
      check_paths: true
      auto_append:
        - ./docs/includes/abbreviations.md
  - pymdownx.superfences
  - toc:
      permalink: true
      toc_depth: 3

nav:
  - readme.md: index.md
  - Overview:
      - Goals: overview/goals.md
      - Features: overview/features.md
      - Design Principals: overview/design.md
      - Structure: overview/structure.md
  - Maintenance:
      - Software Updates: maintenance/software_updates.md
      - Backups: maintenance/backups.md
  - Monitoring:
      - SystemD failures: monitoring/systemd.md
      - Nix Warnings: monitoring/warnings.md
  - Other Features:
      - MOTD: motd.md