mkdocs.yml

site_name: VidioPy
site_author: Soham Tilekar
site_description: A Python Video Editing Library
site_url: https://github.com/SohamTilekar/vidiopy

repo_name: SohamTilekar/vidiopy
repo_url: https://github.com/SohamTilekar/vidiopy
edit_uri: edit/master/docs/

copyright: Copyright © 2023 - 2024 Soham Tilekar Under MIT License

nav:
  - Home: index.md
  - Documentation:
      - Installation: getting_started/download_install.md
      - Getting Started:
          - Quick Presentation: getting_started/quick_presentation.md
          - Basic Concepts: getting_started/basic_concepts.md
          - Read & Write: getting_started/read&write.md
          - Mixing Clips: getting_started/mixing_clip.md
      - Reference Manual:
          - Reference Manual: reference_manual/reference_manual.md
          - Clip: reference_manual/clips/clip.md
          - VideoClips:
              - VideoClip: reference_manual/clips/video_clips/videoclip.md
              - VideoFileClip: reference_manual/clips/video_clips/videofileclip.md
              - ImageClip: reference_manual/clips/video_clips/imageclips.md
              - ImageSequenceClip: reference_manual/clips/video_clips/imagesequenceclip.md
              - Mixing VideoClip: reference_manual/clips/video_clips/mixing_clips.md
          - AudioClips:
              - AudioClip: reference_manual/clips/audio_clips/audioclip.md
              - AudioFileClip: reference_manual/clips/audio_clips/audiofileclip.md
              - AudioArrayClip: reference_manual/clips/audio_clips/audioarrayclip.md
              - SilenceClip: reference_manual/clips/audio_clips/silenceclip.md
              - Mixing AudioClip: reference_manual/clips/audio_clips/mixingaudio.md

  - Contribute:
      - Contributing: more/CONTRIBUTING.md
      - Style Guide: more/code style guide.md

theme:
  name: material
  custom_dir: overrides
  logo: media/vidiopy_logo.png
  favicon: media/vidiopy_logo.png
  icon:
    annotation: material/more
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  features:
    - header.autohide
    - navigation.footer
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.select
    - content.code.annotate
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.instant.preview
    - navigation.path
    - navigation.prune
    - navigation.tracking
    - content.action.edit
    - content.action.view
    - toc.follow

plugins:
  - search

markdown_extensions:
  - toc:
      permalink: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.betterem
  - pymdownx.keys
  - pymdownx.details
  - abbr
  - admonition
  - attr_list
  - def_list
  - md_in_html
  - footnotes
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols

extra:
  # generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/SohamTilekar/vidiopy
    - icon: fontawesome/solid/paper-plane
      link: mailto:sohamtilekar233@gmail.com

extra_css:
  - "stylesheets/extra.css"