mkdocs.yaml

site_name: "Copier UV"
site_description: "Copier template for Python projects managed by uv"
site_url: "https://ninerealmlabs.github.io/precommit-template"
repo_url: "https://github.com/ninerealmlabs/precommit-template"
repo_name: "ninerealmlabs/precommit-template"

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

nav:
  - Home:
      - Overview: index.md
      - Changelog: https://github.com/ninerealmlabs/precommit-template/releases
      - License: license.md
  # - Usage:
  #   - Requirements: requirements.md
  #   - Generating a project: generate.md
  #   - Working on a project: work.md
  #   - Updating a project: update.md

theme:
  name: material
  icon:
    logo: material/file-check
  features:
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - search.highlight
    - search.suggest
    - toc.follow
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

markdown_extensions:
  - admonition
  - callouts
  - pymdownx.emoji
  - pymdownx.magiclink
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed
  - pymdownx.tasklist
  - toc:
      permalink: "¤"

extra_css:
  - css/custom.css