mkdocs.yml

site_name: gSlapper Documentation
site_description: Complete documentation for gSlapper - GStreamer-based wallpaper player for Wayland
site_author: Nomadcxx
site_url: https://nomadcxx.github.io/gSlapper/

repo_name: Nomadcxx/gSlapper
repo_url: https://github.com/Nomadcxx/gSlapper
edit_uri: edit/development/docs/

theme:
  name: material
  palette:
    - scheme: slate
      primary: green
      accent: green
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: green
      accent: green
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  font:
    text: 'Fira Code'
    code: 'Fira Code'
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.indexes
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
    - getting-started/index.md
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quick-start.md
    - Configuration: getting-started/configuration.md
  - User Guide:
    - user-guide/index.md
    - Video Wallpapers: user-guide/video-wallpapers.md
    - Static Images: user-guide/static-images.md
    - Scaling Modes: user-guide/scaling-modes.md
    - IPC Control: user-guide/ipc-control.md
    - Command Line Options: user-guide/command-line-options.md
    - Persistent Wallpapers: user-guide/persistent-wallpapers.md
  - Advanced:
    - advanced/index.md
    - Transitions: advanced/transitions.md
    - Multi-Monitor Setup: advanced/multi-monitor.md
    - Performance Tuning: advanced/performance.md
    - Troubleshooting: advanced/troubleshooting.md
  - Development:
    - development/index.md
    - Building from Source: development/building.md
    - Contributing: development/contributing.md
    - API Reference: development/api-reference.md
    - Architecture: development/architecture.md
    - Systemd Service: development/systemd-service.md
# Internal working documents - never publish to the docs site
exclude_docs: |
  plans/
  superpowers/
  VERIFICATION_IPC_SOCKET_PRESERVATION.md
  README.md

plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: true

extra_css:
  - css/extra.css