mkdocs.yml

site_name: Docs
site_url: "https://arshiacomplus.github.io/docs/"
site_author: ArshiaComplus
site_description: >-
  Central documentation for my open-source projects, including WarpScanner and python-v2ray.
  
# Repository
repo_name: WarpScanner
repo_url: https://github.com/arshiacomplus/WarpScanner

# Copyright
copyright: Copyright © 2025 arshiacomplus, Inc

# Configuration
theme:
  name: material
  custom_dir: material/overrides
  language: fa
  features:
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.footnote.tooltips
    - header.autohide
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.tabs
    - navigation.tabs.sticky
    - search.highlight
    - search.suggest
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/weather-partly-cloudy
        name: Switch to system preference
        
  font:
    text: Roboto
    code: Roboto Mono
  favicon: assets/favicon.png
  icon:
    logo: logo
# Plugins
plugins:
  - blog
  - search:
      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - minify:
      minify_html: true

# Hooks
hooks:
  - material/overrides/hooks/shortcodes.py
  - material/overrides/hooks/translations.py

# Additional configuration
extra:
  status:
    new: Recently added
    deprecated: Deprecated
  analytics:
    provider: google
    property: !ENV GOOGLE_ANALYTICS_KEY
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/arahiacomplus
    - icon: fontawesome/brands/telegram
      link: https://t.me/arshia_mod_fun
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/@arshiacomplus_official
    - icon: fontawesome/solid/envelope
      link: mailto:arshiacomplus@gmail.com
    - icon: fontawesome/brands/square-twitter
      link: https://x.com/x

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - 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.keys
  - pymdownx.magiclink:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      auto_append:
        - includes/mkdocs.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

not_in_nav: |
  /tutorials/**/*.md

# Page tree
nav:
  - Home: index.md
  - 'python-v2ray':
    - 'Introduction': 'python-v2ray/index.md'
    - 'Getting Started':
      - 'Installation': 'python-v2ray/getting-started/installation.md'
      - 'Quick Start': 'python-v2ray/getting-started/quick-start.md'
    - 'Core Concepts':
      - 'Architecture': 'python-v2ray/core-concepts/architecture.md'
      - 'Config Parser': 'python-v2ray/core-concepts/config-parser.md'
      - 'Tester': 'python-v2ray/core-concepts/tester.md'
      - 'Multiplexing (Mux)': 'python-v2ray/core-concepts/multiplexing.md'
      - 'Speed Testing': 'python-v2ray/core-concepts/speed-testing.md'
      - 'Proxy Chaining (WARP on Any)': 'python-v2ray/core-concepts/proxy-chaining.md'
      - 'Loading from Sources': 'python-v2ray/core-concepts/loading-from-sources.md'
      - 'Deduplicating Configs': 'python-v2ray/core-concepts/deduplicating-configs.md'
    - 'API Reference':
      - 'XrayCore': 'python-v2ray/api/core.md'
      - 'ConfigParams': 'python-v2ray/api/config-parser.md'
      - 'ConnectionTester': 'python-v2ray/api/tester.md'
      - 'Advanced: Monitoring Traffic': 'python-v2ray/api/monitoring-traffic.md' 
    - 'License': 'python-v2ray/license.md'
  - 'وارپ اسکنر':
    - 'توضیحات':
      - 'نصب و راه‌اندازی': 'warp-scanner/getting-started.md'
      - 'لایسنس': 'warp-scanner/license.md'
    - 'بیلد گرفتن':
      - 'توضیحات بیشتر': 'build.md'
      - 'نسخه ویندوز': 'warp-scanner/build/windows.md'
      - 'نسخه لینوکس': 'warp-scanner/build/linux.md'
      - 'نسخه اندروید': 'warp-scanner/build/android.md'