mkdocs.yaml

site_name: Cookiecutter PyPackage
repo_url: https://github.com/leodevian/cookiecutter-pypackage
edit_uri: edit/main/docs/
site_description: Cookiecutter template for modern Python packages
site_author: Léo Bernard
copyright: Copyright © 2024 Léo Bernard

nav:
  - Home:
    - Overview: index.md
    - Changelog: changelog.md

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

theme:
  name: material
  features:
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - content.tooltips
    - navigation.path
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.suggest
    - toc.follow
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

site_dir: site

watch:
  - mkdocs.yaml
  - README.md
  - CHANGELOG.md
  - CONTRIBUTING.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.highlight:
      use_pygments: true
      pygments_lang_class: true
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true

plugins:
  - search