mkdocs.yml

site_name: Kometa Wiki
site_author: meisnate12
site_description: Kometa is an open-source python project allowing you to unlock the potential of your media server.
site_url: https://<slug>.kometa.wiki/en/latest/
repo_name: Kometa
repo_url: https://github.com/Kometa-Team/Kometa

theme:
  name: material
  logo: assets/images/icons/icon.png
  favicon: assets/images/icons/favicon.png
  custom_dir: docs/overrides
  font:
    text: DM Sans
    code: Fira Code
  features:
  - content.code.annotate
  - content.tabs.link
  - content.code.copy
  - header.autohide
  - announce.dismiss
  - navigation.footer
  - navigation.tabs
  - navigation.tabs.sticky
  - navigation.sections
  - navigation.top
  - navigation.tracking
  - toc.follow
  - search.suggest
  - search.highlight
  - search.share
  language: en
  palette:
    scheme: slate
    primary: custom
  icon:
    alternate: material/file-document-multiple-outline
plugins:
- glightbox
- search:
    lang: en
- open-in-new-tab
- include-markdown
- redirects:
    redirect_maps:
      'discord.md': 'https://kometa.wiki/en/nightly/link/'
      'redact.md': 'https://regex101.com/r/DMo1DQ/latest'
      'link.md': 'https://discord.com/invite/kometa-822460010649878528'
      'malauth.md': 'config/authentication.md'
      'traktauth.md': 'config/authentication.md'
      'kometa/install/local.md': 'kometa/install/walkthroughs/local.md'
      'kometa/install/docker.md': 'kometa/install/walkthroughs/docker.md'
      'kometa/install/unraid.md': 'kometa/install/walkthroughs/unraid.md'
      'kometa/install/kubernetes.md': 'kometa/install/walkthroughs/kubernetes.md'
      'kometa/install/qnap.md': 'kometa/install/walkthroughs/qnap.md'
      'kometa/install/synology.md': 'kometa/install/walkthroughs/synology.md'
- material-plausible
extra:
  alternate:
  - name: Latest Docs
    link: /en/latest/
    lang: en
  - name: Develop Docs
    link: /en/develop/
    lang: en
  - name: Nightly Docs
    link: /en/nightly/
    lang: en
  social:
  - icon: fontawesome/solid/heart
    class: md-social__link heart
    link: 'https://github.com/sponsors/meisnate12'
    name: Donate
  - icon: fontawesome/brands/discord
    class: md-social__link
    link: 'https://kometa.wiki/en/latest/discord/'
    name: Discord
  - icon: fontawesome/brands/github
    class: md-social__link
    link: 'https://github.com/Kometa-Team/Kometa'
    name: GitHub
  analytics:
    provider: plausible
    domain: kometa.wiki/en/latest
    src: "https://analytics.kometa.wiki/js/script.js"
markdown_extensions:
- abbr
- admonition
- attr_list
- md_in_html
- neoteroi.cards
- pymdownx.details
- pymdownx.emoji:
    emoji_generator: !!python/name:material.extensions.emoji.to_svg ""
    emoji_index: !!python/name:material.extensions.emoji.twemoji ""
- pymdownx.highlight:
    anchor_linenums: true
    line_spans: __span
    pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
    alternate_style: true
    slugify: !!python/object/apply:pymdownx.slugs.slugify
      kwds:
        case: lower
- pymdownx.tasklist:
    custom_checkbox: true
- pymdownx.tilde
- tables
- toc:
    permalink: true
    toc_depth: 3
extra_css:
- assets/css/extra.css
- https://unpkg.com/tippy.js@6/dist/tippy.css
extra_javascript:
- assets/js/extra.js
- https://unpkg.com/@popperjs/core@2
- https://unpkg.com/tippy.js@6
hooks:
- docs/hooks/copyright.py

nav:
- KOMETA:
  - Home: index.md
  - INSTALLATION:
    - Installing Kometa: kometa/install/overview.md
    - Docker Images: kometa/install/images.md
    - Getting Started: kometa/install/getting_started.md
    - Configuring Kometa: kometa/install/files.md
    - Walkthroughs:
      - Local (Win/Mac/Linux): kometa/install/walkthroughs/local.md
      - Docker: kometa/install/walkthroughs/docker.md
      - unRAID: kometa/install/walkthroughs/unraid.md
      - Kubernetes: kometa/install/walkthroughs/kubernetes.md
      - QNAP: kometa/install/walkthroughs/qnap.md
      - Synology: kometa/install/walkthroughs/synology.md
      - TrueNAS: kometa/install/walkthroughs/truenas.md
  - POST-INSTALL:
    - Run Commands & Env Variables: kometa/environmental.md
    - YAML Files Explained: kometa/yaml.md
    - Log Files & Common Errors: kometa/logs.md
    - Frequently Asked Questions: kometa/faqs.md
    - Explanation Guides: &guides
        - Overview: kometa/guides/overview.md
        - Plex Ratings Explained: kometa/guides/ratings.md
        - Overlays Explained: kometa/guides/overlays.md
        - Kometa Sorting Guide: kometa/guides/order.md
        - Scheduling Kometa Runs Guide: kometa/guides/scheduling.md
        - Image Asset Directory Guide: kometa/guides/assets.md
        - Formula 1 Metadata Guide: kometa/guides/formula.md
        - MediUX Assets Guide: kometa/guides/mediux.md
        - Managing Recommendations: kometa/guides/hub.md
        - Reverting Kometa Changes: kometa/guides/revert.md
        - Switching from PMM to Kometa: kometa/guides/rebrand.md
    - Companion Scripts: &scripts
        - Overview: kometa/scripts/overview.md
        - Quickstart: kometa/scripts/quickstart.md
        - ImageMaid: kometa/scripts/imagemaid.md
        - Kometa Overlay Reset: kometa/scripts/overlay-reset.md
  - USEFUL LINKS: &links
      - Feature Requests: https://features.kometa.wiki/
      - Bugs & Issues: https://github.com/Kometa-Team/Kometa/issues
      - Community Configs: https://github.com/Kometa-Team/Community-Configs
      - Discord Server: https://kometa.wiki/en/latest/discord/
      - Donate/Sponsor Kometa: https://github.com/sponsors/meisnate12
      - Acknowledgements: kometa/acknowledgements.md
- CONFIGURATION FILE:
  - Overview: config/overview.md
  - LIBRARIES:
    - Library Attributes: config/libraries.md
    - File Blocks: config/files.md
    - Library Operations: config/operations.md
  - CONNECTIONS:
    - REQUIRED CONNECTIONS:
      - Plex: config/plex.md
      - TMDb: config/tmdb.md
    - OPTIONAL CONNECTIONS:
      - Tautulli: config/tautulli.md
      - Github: config/github.md
      - OMDb: config/omdb.md
      - MDBList: config/mdblist.md
      - Notifiarr: config/notifiarr.md
      - Gotify: config/gotify.md
      - ntfy: config/ntfy.md
      - AniDB: config/anidb.md
      - Radarr: config/radarr.md
      - Sonarr: config/sonarr.md
      - Trakt: config/trakt.md
      - MyAnimeList: config/myanimelist.md
      - Trakt and MyAnimeList Authentication: config/authentication.md
      - Webhooks: config/webhooks.md
  - OTHER:
    - Settings: config/settings.md
    - Scheduling Parts: config/schedule.md
    - Playlist Files: config/playlists.md
- KOMETA DEFAULTS:
  - Defaults Usage Guide: defaults/guide.md
  - Defaults Files: defaults/files.md
  - COLLECTIONS DEFAULTS:
    - Collections: defaults/collections.md
    - Separators: defaults/separators.md
    - Award:
      - Separator: defaults/award/separator.md
      - Academy Awards (Oscars): defaults/award/oscars.md
      - Berlin Film Festival Awards: defaults/award/berlinale.md
      - British Academy of Film Awards: defaults/award/bafta.md
      - Cannes Film Festival Awards: defaults/award/cannes.md
      - César Awards: defaults/award/cesar.md
      - Critics Choice Awards: defaults/award/choice.md
      - Emmy Awards: defaults/award/emmy.md
      - Golden Globe Awards: defaults/award/golden.md
      - Independent Spirit Awards: defaults/award/spirit.md
      - National Film Registry: defaults/award/nfr.md
      - People's Choice Awards: defaults/award/pca.md
      - Razzie Awards: defaults/award/razzie.md
      - Screen Actors Guild Awards: defaults/award/sag.md
      - Sundance Film Festival Awards: defaults/award/sundance.md
      - Toronto International Film Festival: defaults/award/tiff.md
      - Venice Film Festival Awards: defaults/award/venice.md
    - Chart:
      - Separator: defaults/chart/separator.md
      - Basic Charts: defaults/chart/basic.md
      - AniList Charts: defaults/chart/anilist.md
      - IMDb Charts: defaults/chart/imdb.md
      - Letterboxd Charts: defaults/chart/letterboxd.md
      - MyAnimeList Charts: defaults/chart/myanimelist.md
      - Tautulli Charts: defaults/chart/tautulli.md
      - TMDb Charts: defaults/chart/tmdb.md
      - Trakt Charts: defaults/chart/trakt.md
      - Other Charts: defaults/chart/other.md
    - Content:
      - Genres: defaults/both/genre.md
      - Franchises (Movie): defaults/movie/franchise.md
      - Franchises (Show): defaults/show/franchise.md
      - Universes: defaults/both/universe.md
      - Based On...: defaults/both/based.md
      - Collectionless: defaults/both/collectionless.md
    - Content Rating:
      - US Content Ratings (Movie): defaults/movie/content_rating_us.md
      - US Content Ratings (Show): defaults/show/content_rating_us.md
      - UK Content Ratings: defaults/both/content_rating_uk.md
      - DE Content Ratings: defaults/both/content_rating_de.md
      - AU Content Ratings: defaults/both/content_rating_au.md
      - NZ Content Ratings: defaults/both/content_rating_nz.md
      - MyAnimeList Content Ratings: defaults/both/content_rating_mal.md
      - Common Sense Media Content Ratings: defaults/both/content_rating_cs.md
    - Location:
      - Countries (Movie): defaults/movie/country.md
      - Countries (Show): defaults/show/country.md
      - Regions (Movie): defaults/movie/region.md
      - Regions (Show): defaults/show/region.md
      - Continents (Movie): defaults/movie/continent.md
      - Continents (Show): defaults/show/continent.md
    - Media:
      - Aspect Ratio: defaults/both/aspect.md
      - Resolutions: defaults/both/resolution.md
      - Audio Languages: defaults/both/audio_language.md
      - Subtitle Languages: defaults/both/subtitle_language.md
    - People:
      - Actors: defaults/both/actor.md
      - Directors: defaults/movie/director.md
      - Producers: defaults/movie/producer.md
      - Writers: defaults/movie/writer.md
    - Production:
      - Networks: defaults/show/network.md
      - Streaming: defaults/both/streaming.md
      - Studios: defaults/both/studio.md
    - Time:
      - Seasonal: defaults/movie/seasonal.md
      - Years: defaults/both/year.md
      - Decades (Movie): defaults/movie/decade.md
      - Decades (Show): defaults/show/decade.md
  - OVERLAY DEFAULTS:
    - Overlays: defaults/overlays.md
    - Chart:
      - Ribbon: defaults/overlays/ribbon.md
    - Content:
      - Episode Info: defaults/overlays/episode_info.md
      - MediaStinger: defaults/overlays/mediastinger.md
      - Ratings: defaults/overlays/ratings.md
      - Status: defaults/overlays/status.md
    - Content Rating:
      - US Content Ratings (Movie): defaults/overlays/content_rating_us_movie.md
      - US Content Ratings (Show): defaults/overlays/content_rating_us_show.md
      - UK Content Ratings: defaults/overlays/content_rating_uk.md
      - DE Content Ratings: defaults/overlays/content_rating_de.md
      - AU Content Ratings: defaults/overlays/content_rating_au.md
      - NZ Content Ratings: defaults/overlays/content_rating_nz.md
      - Common Sense Age Ratings: defaults/overlays/commonsense.md
    - Media:
      - Aspect Ratio: defaults/overlays/aspect.md
      - Audio Codec: defaults/overlays/audio_codec.md
      - Audio/Subtitle Language Count: defaults/overlays/language_count.md
      - Audio/Subtitle Language Flags: defaults/overlays/languages.md
      - Resolution/Edition: defaults/overlays/resolution.md
      - Runtimes: defaults/overlays/runtimes.md
      - Versions: defaults/overlays/versions.md
      - Video Format: defaults/overlays/video_format.md
    - Production:
      - Networks: defaults/overlays/network.md
      - Streaming: defaults/overlays/streaming.md
      - Studios: defaults/overlays/studio.md
    - Utility:
      - Direct Play Only: defaults/overlays/direct_play.md
  - PLAYLIST DEFAULTS:
    - Playlists: defaults/playlist.md
- FILES & BUILDERS:
  - Overview: files/overview.md
  - FILES:
    - Collection Files: files/collections.md
    - Overlay Files: files/overlays.md
    - Playlist Files: files/playlists.md
    - Metadata Files: files/metadata.md
    - Definition Templates: files/templates.md
    - Dynamic Collections: files/dynamic.md
    - Dynamic Collection Types & Data: files/dynamic_types.md
  - DEFINITION ATTRIBUTES:
    - Builders:
      - Overview: files/builders/overview.md
      - Plex:
        - Overview: files/builders/plex/overview.md
        - Smart Filter: files/builders/plex/smart-filter.md
        - All: files/builders/plex/all.md
        - Collectionless: files/builders/plex/collectionless.md
        - Pilots: files/builders/plex/pilots.md
        - Search: files/builders/plex/search.md
        - Watchlist: files/builders/plex/watchlist.md
      - TMDb:
        - Overview: files/builders/tmdb/overview.md
        - Standard:
          - Collection: files/builders/tmdb/standard/collection.md
          - Company: files/builders/tmdb/standard/company.md
          - Keyword: files/builders/tmdb/standard/keyword.md
          - List: files/builders/tmdb/standard/list.md
          - Movie: files/builders/tmdb/standard/movie.md
          - Network: files/builders/tmdb/standard/network.md
          - Show: files/builders/tmdb/standard/show.md
        - Chart:
          - Airing Today: files/builders/tmdb/chart/airing-today.md
          - Now Playing: files/builders/tmdb/chart/now-playing.md
          - On The Air: files/builders/tmdb/chart/on-the-air.md
          - Popular: files/builders/tmdb/chart/popular.md
          - Top Rated: files/builders/tmdb/chart/top-rated.md
          - Trending Daily: files/builders/tmdb/chart/trending-daily.md
          - Trending Weekly: files/builders/tmdb/chart/trending-weekly.md
          - Upcoming: files/builders/tmdb/chart/upcoming.md
        - Discover:
          - Movie: files/builders/tmdb/discover/movie.md
          - Show: files/builders/tmdb/discover/show.md
        - People:
          - Actor: files/builders/tmdb/people/actor.md
          - Crew: files/builders/tmdb/people/crew.md
          - Director: files/builders/tmdb/people/director.md
          - Producer: files/builders/tmdb/people/producer.md
          - Writer: files/builders/tmdb/people/writer.md
      - TVDb:
        - Overview: files/builders/tvdb/overview.md
        - List: files/builders/tvdb/list.md
        - Movie: files/builders/tvdb/movie.md
        - Show: files/builders/tvdb/show.md
      - IMDb:
        - Overview: files/builders/imdb/overview.md
        - Award: files/builders/imdb/award.md
        - Chart: files/builders/imdb/chart.md
        - ID: files/builders/imdb/id.md
        - List: files/builders/imdb/list.md
        - Search: files/builders/imdb/search.md
        - Watchlist: files/builders/imdb/watchlist.md
      - Trakt:
        - Overview: files/builders/trakt/overview.md
        - Box Office: files/builders/trakt/box-office.md
        - Chart: files/builders/trakt/chart.md
        - List: files/builders/trakt/list.md
        - Recommendations: files/builders/trakt/recommendations.md
        - UserList: files/builders/trakt/userlist.md
      - Tautulli:
        - Overview: files/builders/tautulli/overview.md
        - Popular: files/builders/tautulli/popular.md
        - Watched: files/builders/tautulli/watched.md
      - Radarr:
        - Overview: files/builders/radarr/overview.md
        - All: files/builders/radarr/all.md
        - Taglist: files/builders/radarr/taglist.md
      - Sonarr:
        - Overview: files/builders/sonarr/overview.md
        - All: files/builders/sonarr/all.md
        - Taglist: files/builders/sonarr/taglist.md
      - MDBList:
        - Overview: files/builders/mdblist/overview.md
        - List: files/builders/mdblist/list.md
      - Letterboxd:
        - Overview: files/builders/letterboxd/overview.md
        - List: files/builders/letterboxd/list.md
        - User Films: files/builders/letterboxd/user_films.md
        - User Reviews: files/builders/letterboxd/user_reviews.md
      - ICheckMovies:
        - Overview: files/builders/icheckmovies/overview.md
        - List: files/builders/icheckmovies/list.md
      - BoxOfficeMojo:
        - Overview: files/builders/boxofficemojo/overview.md
        - All Time: files/builders/boxofficemojo/all-time.md
        - Domestic: files/builders/boxofficemojo/domestic.md
        - International: files/builders/boxofficemojo/international.md
        - Never Hit: files/builders/boxofficemojo/never.md
        - Other Records: files/builders/boxofficemojo/record.md
        - Worldwide: files/builders/boxofficemojo/world.md
      - StevenLu:
        - Overview: files/builders/stevenlu/overview.md
        - Popular: files/builders/stevenlu/popular.md
      - Text File:
        - Overview: files/builders/textfile/overview.md
        - Text File: files/builders/textfile/text-file.md
      - AniDB:
        - Overview: files/builders/anidb/overview.md
        - ID: files/builders/anidb/id.md
        - Relation: files/builders/anidb/relation.md
        - Tag: files/builders/anidb/tag.md
        - Tag Name: files/builders/anidb/tag_name.md
      - AniList:
        - Overview: files/builders/anilist/overview.md
        - ID: files/builders/anilist/id.md
        - Popular: files/builders/anilist/popular.md
        - Relations: files/builders/anilist/relations.md
        - Search: files/builders/anilist/search.md
        - Studio: files/builders/anilist/studio.md
        - Top Rated: files/builders/anilist/top_rated.md
        - Trending: files/builders/anilist/trending.md
        - Userlist: files/builders/anilist/userlist.md
      - MyAnimeList:
        - Overview: files/builders/myanimelist/overview.md
        - Airing: files/builders/myanimelist/airing.md
        - All: files/builders/myanimelist/all.md
        - Favorite: files/builders/myanimelist/favorite.md
        - ID: files/builders/myanimelist/id.md
        - Movie: files/builders/myanimelist/movie.md
        - OVA: files/builders/myanimelist/ova.md
        - Popular: files/builders/myanimelist/popular.md
        - Search: files/builders/myanimelist/search.md
        - Season: files/builders/myanimelist/season.md
        - Special: files/builders/myanimelist/special.md
        - Suggested: files/builders/myanimelist/suggested.md
        - TV: files/builders/myanimelist/tv.md
        - Upcoming: files/builders/myanimelist/upcoming.md
        - UserList: files/builders/myanimelist/userlist.md
    - Filters: files/filters.md
    - Definition Settings: files/settings.md
    - Radarr/Sonarr Settings: files/arr.md
    - Collection/Playlist Metadata Updates: files/updates.md
    - Item Metadata Updates: files/item_updates.md
- MISCELLANEOUS:
  - EXPLANATION GUIDES: *guides
  - COMPANION SCRIPTS: *scripts
  - USEFUL LINKS: *links
- SPONSOR: https://github.com/sponsors/meisnate12

#  - SHOWCASE:
#    - Overlays Showcase: showcase/overlays.md