mkdocs.yml

site_name: DIVE
site_url: https://kitware.github.io/dive
site_description: Documentation for DIVE
site_author: Kitware

repo_url: https://github.com/Kitware/dive

theme:
  name: material
  highlightjs: true
  logo: images/General/Kitware-Mark.png
  palette:
    primary: black
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.expand

extra_css: [extra.css]

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.highlight:
      linenums: true
  - pymdownx.superfences
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/kitware/dive
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/r/kitware/viame-web
    - icon: fontawesome/brands/discourse
      link: https://discourse.kitware.com/c/viame-dive/17
  analytics:
    provider: google
    property: UA-6042509-43

nav:
  - User Guide:
    - Home: index.md
    - Web Version: Web-Version.md
    - Desktop Version: Dive-Desktop.md
    - Annotation Quickstart: Annotation-QuickStart.md
    - User Interface Guide:
      - Introduction: Annotation-User-Interface-Overview.md
      - Navigation and Editing Bar: UI-Navigation-Editing-Bar.md
      - Annotation Window: UI-Annotation-View.md
      - Type List: UI-Type-List.md
      - Track List: UI-Track-List.md
      - Timeline: UI-Timeline.md
      - Attributes: 
        - Attributes: UI-Attributes.md
        - Attributes Configuration: UI-AttributeConfiguration.md
        - Attributes Details: UI-AttributeDetails.md
        - Attribute Track Filtering: UI-AttributeTrackFiltering.md
      - Group Manager: UI-Group-Manager.md
    - Keyboard Shortcut Reference: Mouse-Keyboard-Shortcuts.md
    - Advanced features:
      - Pipeline Import and Export: Pipeline-Import-Export.md
      - Command Line Tools: Command-Line-Tools.md
      - MultiCamera Data (beta): Multicamera-data.md
    - Screenshots: Screenshots.md
    - Support: Support.md
  - Pipelines & Training: Pipeline-Documentation.md
  - Data Formats: DataFormats.md
  - Administrator Guide:
    - Deployment Options Overview: Deployment-Overview.md
    - Provisioning Google Cloud: Deployment-Provision.md
    - Running with Docker Compose: Deployment-Docker-Compose.md
    - Cloud Storage Integration: Deployment-Storage.md
    - REST API Specification: https://viame.kitware.com/api/v1
  - Frequently Asked Questions: FAQ.md
  - Support: Support.md