mkdocs.yml

site_name: "Rank Torrent Name"
site_description: "Rank Torrent Name is a powerful Python library that revolutionizes the way you handle filenames."
site_author: 'Dreu LaVelle'
site_url: 'https://ranktorrentname.com'

repo_name: 'RTN'
repo_url: 'https://github.com/dreulavelle/rank-torrent-name'

nav:
  - Home: index.md
  - Users: 
    - Getting Started: users/faq.md
    - Languages: users/languages.md
    - Profiles: users/profiles.md
  - Developers: 
    - Introduction: devs/introduction.md
    - Parsing: devs/parsing.md
    - Settings Model: devs/settings.md
    - Ranking Model: devs/ranking.md
    - Models: devs/models.md
    - Sorting: devs/sorting.md
    - Extras: devs/extras.md
  - Modules: 
    - Parser: devs/modules/parser.md
    - Ranker: devs/modules/ranker.md
    - Fetch: devs/modules/fetch.md
    - Models: devs/modules/models.md
    - Exceptions: devs/modules/exceptions.md
    - Patterns: devs/modules/patterns.md
    - Extras: devs/modules/extras.md
  - Contributing: contributing.md
  - License: license.md

plugins:
  - search  
  - mkdocstrings:
      handlers:
        python:
          paths: [RTN]
          # options:
          #   heading_slug_func: 'slugify'

theme:
  name: 'material'
  custom_dir: overrides
  features:
      - navigation.tabs
      - navigation.tabs.sticky
      - navigation.tracking
      - navigation.instant
      - navigation.instant.progress
      - navigation.sections
      - navigation.indexes
      - navigation.top
      - navigation.pruning
      - navigation.path
      - search.suggest
      - search.share
      - content.code.annotate
      - content.code.copy
      - announce.dismiss
  icon:
    logo: logo

  palette:
    - media: "(prefers-color-scheme)"
      scheme: default
      toggle:
        icon: material/brightness-auto
        name: Follow system preferences

    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: red
      toggle:
        icon: material/brightness-5
        name: Set fire to my eyes!

    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: red
      toggle:
        icon: material/brightness-4
        name: Darken the world!
  font:
    text: 'Ubuntu'
    code: 'Ubuntu Mono'

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/extra.js

extra:
  social:
    - icon: 'fontawesome/brands/discord'
      link: 'https://discord.gg/rivenmedia' 
    - icon: 'fontawesome/brands/github'
      link: 'https://github.com/dreulavelle/rank-torrent-name'

markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - tables
  - codehilite:
      linenums: false
  - toc:
      permalink: true
      toc_depth: 2
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format