mkdocs.yml

site_name: Couleur Tweak Tips
site_url: https://ctt.cx/

# https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository
repo_url: https://github.com/couleur-tweak-tips/CTT
repo_name: couleur-tweak-tips/CTT
edit_uri: edit/main/docs/

nav:
  - About CTT:
    - index.md
    - Contributing: contributing.md
    - Contact: contact.md
    - Credits: credits.md
    #- test.md
    
  - Video:
    - video/index.md
    - Which codec should I use?: video/codecguide.md
    - Send To: video/sendto.md

    - FFmpeg scripts:
      - video/ffmpeg/index.md
      - Upscaling: video/ffmpeg/upscaling.md
      - Tmix: video/ffmpeg/tmix.md

    - Video cutters:
      - video/cutters/index.md
      - Avidemux: video/cutters/avidemux.md
      - LosslessCut: video/cutters/losslesscut.md

    - Smoothie:
      - video/smoothie/index.md
      - Installation: video/smoothie/installation.md
      - Use cases examples: video/smoothie/usecases.md
      - Recipe configuration: video/smoothie/recipe.md
      - Troubleshooting: video/smoothie/troubleshooting.md
      - Smoothie vs. blur: video/smoothie/smoothievsblur.md
      - Command line arguments: video/smoothie/cli.md
      - Frameserver rendering: video/smoothie/frameserver.md

    - Voukoder:
      - video/voukoder/index.md
      - Configuration: video/voukoder/configuration.md
      - VEGAS Pro: video/voukoder/vegas.md
      - Premiere Pro: video/voukoder/premiere.md
      - After Effects: video/voukoder/after-effects.md
      - Davinci Resolve: video/voukoder/resolve.md


    - OBS Studio:
        - video/obs/index.md
        - Installation ↗: video/obs/install.md
        - Docks: video/obs/docks.md
        - Source types: video/obs/sourcetypes.md
        - General: video/obs/general.md
        - Output: video/obs/output.md
        - Audio: video/obs/audio.md
        - Video: video/obs/video.md
        - Hotkeys: video/obs/hotkeys.md
        - Advanced: video/obs/advanced.md
        - Linux: 
          - video/obs/linux/index.md
          - NvFBC: video/obs/linux/nvfbc.md
          - OBS VkCapture: video/obs/linux/obs-vkcapture.md
  - Programs:
    - software/index.md
    - Everything: software/everything.md
    - Scoop: software/scoop.md
    - Winget: software/winget.md
    - Windows Terminal: software/windows-terminal.md
    - Visual Studio IDEs: software/visual-studio-ides.md

  - Misc:
    - misc/index.md
    - File sharing: misc/filesharing.md
    - mkdocs: misc/mkdocs.md
    - yt-dlp: misc/yt-dlp.md

not_in_nav:
  alita.md

theme:
  name: material
  logo: assets/logos/logo.png
  favicon: assets/logos/favicon.png
  custom_dir: overrides
  icon:
    # annotation: material/plus-circle
    repo: fontawesome/brands/github
  
  features:
    # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#setting-up-navigation
    - navigation.instant
    # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation#progress-indicator
    - navigation.instant.progress
    - navigation.path
    # This breaks navigation.expand at the moment
    # - navigation.prune
    - navigation.expand
    - navigation.indexes
    - navigation.top
    - navigation.tabs
    - navigation.sections
    # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#table-of-contents
    - toc.follow
    # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search/#search-suggestions
    - search.suggest
    - search.highlight
    - search.share
    # https://squidfunk.github.io/mkdocs-material/setup/adding-a-git-repository/#code-actions
    - content.action.edit
    # https://squidfunk.github.io/mkdocs-material/reference/content-tabs/#linked-content-tabs
    - content.tabs.link
    - content.action.view
    # https://squidfunk.github.io/mkdocs-material/reference/code-blocks/#configuration
    - content.code.copy
    - content.code.select
    - content.code.annotate
    - content.tooltips
    # https://squidfunk.github.io/mkdocs-material/setup/setting-up-the-footer#navigation
    - navigation.footer

  # a custom colour scheme could be good in the future
  # dark purple accent and primary don't look the best
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: deep purple
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: deep purple
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode


extra:
  #homepage: https://ctt.cx
  social:
  - icon: fontawesome/brands/discord
    link: https://discord.com/invite/aPVMJy78Pa
    name: The Couleur Tweak Tips Discord server

  - icon: fontawesome/brands/github
    link: https://github.com/couleur-tweak-tips
    name: Couleur Tweak Tips on GitHub

  - icon: fontawesome/brands/telegram
    link: https://t.me/Couleur
    name: Contact Couleur on Telegram

  - icon: fontawesome/brands/mastodon
    link: https://hachyderm.io/@coler
    name: Follow Couleur on Hachyderm (Mastodon)


extra_css:
  - assets/css/extra.css


plugins:

  # https://squidfunk.github.io/mkdocs-material/setup/setting-up-site-search
  - search

  # makes image enlarge on click https://blueswen.github.io/mkdocs-glightbox/
  - glightbox:
      effect: none
      height: 100vw

  # https://timvink.github.io/mkdocs-git-revision-date-localized-plugin
  - git-revision-date-localized:
      enabled: !ENV [CI, false]
      enable_creation_date: true

#
# Python Markdown
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown
# https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions
#
markdown_extensions:
  - markdown.extensions.toc:
      permalink: ""
      
  # https://squidfunk.github.io/mkdocs-material/reference/admonitions
  - admonition
  - footnotes
  - pymdownx.details
  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#superfences
  - pymdownx.superfences

  # https://squidfunk.github.io/mkdocs-material/reference/annotations
  - abbr

  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#attribute-lists
  - attr_list
  - md_in_html

  # https://squidfunk.github.io/mkdocs-material/reference/formatting
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde

  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#inlinehilite
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite

  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#snippets
  - pymdownx.snippets:
      auto_append:
        - includes/abbreviations.md

  # https://squidfunk.github.io/mkdocs-material/reference/content-tabs
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower



  # https://squidfunk.github.io/mkdocs-material/reference/icons-emojis
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      options:
        custom_icons:
          - overrides/.icons

  # https://squidfunk.github.io/mkdocs-material/reference/lists
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true