mkdocs.yml

site_name: Video Annotation Tool
site_description: A PyQt6 GUI tool for analyzing and annotating OSL datasets (OpenSportsLab)
site_author: OpenSportsLab
repo_url: https://github.com/OpenSportsLab/VideoAnnotationTool
repo_name: OpenSportsLab/VideoAnnotationTool

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - toc.integrate
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.action.edit

# Optional: logo and favicon if we have them
# logo: assets/logo.png
# favicon: assets/favicon.ico

nav:
  - Home: index.md
  - Installation: installation.md
  - Getting Started: getting_started.md
  - User Guide:
      - Overview: gui_overview.md
      - Using the Tool:
          - Interface Tour: gui_overview.md
          - Creating a Project: creating_project.md
          - Import & Export: import_export.md
          - Labels & Categories: labels_categories.md
          - Editing Annotations: editing.md
          - Saving & Loading: saving_loading.md
          - Keyboard Shortcuts: shortcuts.md
      - Batch Tools: batch_tools.md
  - Troubleshooting: troubleshooting.md
  - FAQ: faq.md
  - About: about.md
  - Contributing: contributing.md
  - Changelog: changelog.md

markdown_extensions:
  - admonition
  - toc:
      permalink: true
  - footnotes
  - tables

  # Better layout control
  - attr_list
  - md_in_html

  # Pymdown extensions (Material-recommended)
  - pymdownx.details
  - pymdownx.snippets
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.extra

  # Code highlighting (more robust with Material)
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true


plugins:
  - search