mkdocs.yml

# Copyright (c) 2019-2020 Abhishek Thakur(@abhiTronix) <abhi.una12@gmail.com>

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at

#    http://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# Project information
site_name: VidGear
site_url: https://abhitronix.github.io/vidgear/
site_author: Abhishek Thakur
site_description: >-
  A High-Performance Video-Processing Python Framework for building complex real-time media applications. 🔥

# Repository
repo_name: abhiTronix/vidgear
repo_url: https://github.com/abhiTronix/vidgear
edit_uri: ""

# Google analytics
google_analytics: ['UA-131929464-1', 'abhitronix.github.io']

# Copyright
copyright: Copyright &copy; 2019 - 2021 Abhishek Thakur(@abhiTronix)

# Configuration
theme:
  name: material
  custom_dir: docs/overrides

  # Don't include MkDocs' JavaScript
  include_search_page: false
  search_index_only: true

  # Default values, taken from mkdocs_theme.yml
  language: en
  features:
    - header.autohide
    - navigation.tabs
    - navigation.top
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: purple
      accent: dark purple
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: red
      accent: red
      toggle:
        icon: material/weather-night
        name: Switch to light mode
  font:
    text: Nunito 
    code: IBM Plex
  icon:
    logo: logo
  logo: assets/images/logo.svg
  favicon: assets/images/favicon-32.png

# Plugins
plugins:
  - search
  - git-revision-date-localized
  - minify:
      minify_html: true
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          rendering:
            show_root_heading: false
            show_root_toc_entry: false
            show_source: true
            heading_level: 3
  - exclude:
      glob:
        - overrides/assets/README.md

# Customization
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/abhiTronix
    - icon: fontawesome/brands/gitter
      link: https://gitter.im/vidgear/community
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/abhishek-singh-thakur-a37845a5
    - icon: fontawesome/brands/dev
      link: https://dev.to/abhitronix
  manifest: site.webmanifest
  version:
    provider: mike


extra_css:
    - assets/stylesheets/custom.css
  
extra_javascript:
    - assets/javascripts/extra.js

# Extensions
markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - toc:
      permalink: ⚓
      slugify: !!python/name:pymdownx.slugs.uslugify
  - codehilite:
      guess_lang: false
  - pymdownx.arithmatex
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.inlinehilite
  - pymdownx.highlight
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: abhiTronix
      repo: vidgear
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Page tree
nav:
  - Home: 
    - Overview: index.md
    - Installation: 
      - Installation Overview: installation.md
      - Install using pip: installation/pip_install.md
      - Install from source: installation/source_install.md
    - Switching from OpenCV: switch_from_cv.md
    - Contribution Guidelines: 
      - Contribution Overview: contribution.md
      - Submitting an Issue Guidelines: contribution/issue.md
      - Submitting Pull Request(PR) Guidelines: contribution/PR.md
    - Release Notes: changelog.md
    - License: license.md
  - Gears:
    - Introduction: gears.md
    - CamGear: 
      - Overview: gears/camgear/overview.md
      - Usage Examples: gears/camgear/usage.md
      - Advanced:
        - Source Tweak Parameters: gears/camgear/advanced/source_params.md
      - Parameters: gears/camgear/params.md
      - References: bonus/reference/camgear.md
      - FAQs: help/camgear_faqs.md
    - PiGear: 
      - Overview: gears/pigear/overview.md
      - Usage Examples: gears/pigear/usage.md
      - Parameters: gears/pigear/params.md
      - References: bonus/reference/pigear.md
      - FAQs: help/pigear_faqs.md
    - VideoGear: 
      - Overview: gears/videogear/overview.md
      - Usage Examples: gears/videogear/usage.md
      - Parameters: gears/videogear/params.md
      - References: bonus/reference/videogear.md
      - FAQs: help/videogear_faqs.md
    - ScreenGear: 
      - Overview: gears/screengear/overview.md
      - Usage Examples: gears/screengear/usage.md
      - Parameters: gears/screengear/params.md
      - References: bonus/reference/screengear.md
      - FAQs: help/screengear_faqs.md
    - WriteGear:
      - Introduction: gears/writegear/introduction.md
      - Compression Mode:
        - Overview: gears/writegear/compression/overview.md
        - Usage Examples: gears/writegear/compression/usage.md
        - Advanced: 
          - Custom FFmpeg Commands: gears/writegear/compression/advanced/cciw.md
          - FFmpeg Installation: gears/writegear/compression/advanced/ffmpeg_install.md
        - Parameters: gears/writegear/compression/params.md
      - Non-Compression Mode:
        - Overview: gears/writegear/non_compression/overview.md
        - Usage Examples: gears/writegear/non_compression/usage.md
        - Parameters: gears/writegear/non_compression/params.md
      - References: bonus/reference/writegear.md
      - FAQs: help/writegear_faqs.md
    - StreamGear: 
      - Overview: gears/streamgear/overview.md
      - Usage Examples: gears/streamgear/usage.md
      - Advanced:
          - FFmpeg Installation: gears/streamgear/ffmpeg_install.md
      - Parameters: gears/streamgear/params.md
      - References: bonus/reference/streamgear.md
      - FAQs: help/streamgear_faqs.md
    - NetGear: 
      - Overview: gears/netgear/overview.md
      - Usage Examples: gears/netgear/usage.md
      - Advanced Usage:
        - Multi-Servers Mode: gears/netgear/advanced/multi_server.md
        - Multi-Clients Mode: gears/netgear/advanced/multi_client.md
        - Bidirectional Mode: gears/netgear/advanced/bidirectional_mode.md
        - Secure Mode: gears/netgear/advanced/secure_mode.md 
        - Frame Compression: gears/netgear/advanced/compression.md 
      - Parameters: gears/netgear/params.md
      - References: bonus/reference/netgear.md
      - FAQs: help/netgear_faqs.md
    - WebGear: 
      - Overview: gears/webgear/overview.md
      - Usage Examples: gears/webgear/usage.md
      - Advanced Usages: gears/webgear/advanced.md
      - Parameters: gears/webgear/params.md
      - References: bonus/reference/webgear.md
      - FAQs: help/webgear_faqs.md
    - WebGear_RTC: 
      - Overview: gears/webgear_rtc/overview.md
      - Usage Examples: gears/webgear_rtc/usage.md
      - Advanced Usages: gears/webgear_rtc/advanced.md
      - Parameters: gears/webgear_rtc/params.md
      - References: bonus/reference/webgear_rtc.md
      - FAQs: help/webgear_rtc_faqs.md
    - NetGear_Async: 
      - Overview: gears/netgear_async/overview.md
      - Usage Examples: gears/netgear_async/usage.md
      - Parameters: gears/netgear_async/params.md
      - References: bonus/reference/netgear_async.md
      - FAQs: help/netgear_async_faqs.md
    - Stabilizer Class: 
      - Overview: gears/stabilizer/overview.md
      - Usage Examples: gears/stabilizer/usage.md
      - Parameters: gears/stabilizer/params.md
      - References: bonus/reference/stabilizer.md
      - FAQs: help/stabilizer_faqs.md
  - Bonus:
    - API References:
      - vidgear.gears: 
        - CamGear API: bonus/reference/camgear.md
        - PiGear API: bonus/reference/pigear.md
        - VideoGear API: bonus/reference/videogear.md
        - ScreenGear API: bonus/reference/screengear.md
        - WriteGear API: bonus/reference/writegear.md
        - StreamGear API: bonus/reference/streamgear.md
        - NetGear API: bonus/reference/netgear.md
        - Stabilizer Class: bonus/reference/stabilizer.md
        - Helper Methods: bonus/reference/helper.md
      - vidgear.gears.asyncio:
        - WebGear API: bonus/reference/webgear.md
        - WebGear_RTC API: bonus/reference/webgear_rtc.md
        - NetGear_Async API: bonus/reference/netgear_async.md
        - Helper Methods: bonus/reference/helper_async.md
    - Colorspace Manipulation: bonus/colorspace_manipulation.md
    - Threaded Queue Mode: bonus/TQM.md
  - Help:
    - Help VidGear 'n' Get Help:
      - Helping VidGear: help.md
      - Getting Help: help/get_help.md
    - Frequently Asked Questions:
      - General FAQs: help/general_faqs.md
      - Stabilizer Class FAQs: help/stabilizer_faqs.md
      - CamGear FAQs: help/camgear_faqs.md
      - PiGear FAQs: help/pigear_faqs.md
      - VideoGear FAQs: help/videogear_faqs.md
      - ScreenGear FAQs: help/screengear_faqs.md
      - WriteGear FAQs: help/writegear_faqs.md
      - StreamGear FAQs: help/streamgear_faqs.md
      - NetGear FAQs: help/netgear_faqs.md
      - WebGear FAQs: help/webgear_faqs.md
      - WebGear_RTC FAQs: help/webgear_rtc_faqs.md
      - NetGear_Async FAQs: help/netgear_async_faqs.md