mkdocs.yml

# yaml-language-server: $schema=https://squidfunk.github.io/mkdocs-material/schema.json

# Project information
site_author: Vasiliy Kiryanov
site_name: qCrawl
site_url: https://qcawl.org/
site_description: Fast asynchronous web crawler framework, supporting distributed crawling, deduplication,
  and extensible middleware.

nav:
  - Home: index.md
  - Getting Started:
    - 10 mins overview: getting-started/overview.md
    - Installation: getting-started/installation.md
    - Examples: getting-started/examples.md
#    - Tutorial: getting-started/tutorial.md
  - Core Concepts:
      - Command-Line Interface: concepts/cli.md
      - Spiders: concepts/spiders.md
      - Selectors: concepts/selectors.md
      - Items: concepts/items.md
      - Item Pipeline: concepts/item_pipeline.md
      - Exporters: concepts/exporters.md
      - Middlewares: concepts/middlewares.md
      - Requests and Responses: concepts/requests_responses.md
      - Settings: concepts/settings.md
  - Built-in Components:
      - Logging: built-in/logging.md
      - Stat Collection: built-in/stats.md
  - Advanced Topics:
      - Authentication: advanced-topics/authentication.md
      - Crawling ordering: advanced-topics/crawl_ordering.md
      - Data extraction: advanced-topics/data_extraction.md
      - Error recovery: advanced-topics/error_recovery.md
      - Link filtering: advanced-topics/link_filtering.md
      - Pagination: advanced-topics/pagination.md
      - Rate limiting: advanced-topics/rate_limiting.md
      - Browser Automation: advanced-topics/browser_automation.md
      - Anti-Bot Evasion: advanced-topics/anti_bot_evasion.md
#    - Deduplication: advanced/deduplication.md
#    - Performance Optimization: advanced/performance_optimization.md
  - Extending qCrawl:
    - Architecture overview: extending/architecture_overview.md
    - Middleware: extending/middleware.md
    - Signals: extending/signals.md
    - Scheduler: extending/scheduler.md
    - Testing: extending/testing.md

# Repository
repo_url: https://github.com/crawlcore/qcrawl
repo_name: crawlcore/qcrawl

# Copyright
copyright: Copyright © 2025 Vasiliy Kiryanov

plugins:
  - search

# Configuration
theme:
  name: material
  features:
    - content.footnote.tooltips
    - navigation.expand
    - navigation.indexes
    - toc.integrate
    - content.code.copy
  font:
    text: Roboto
    code: Roboto Mono
  icon:
    logo: logo
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

extra:
  social:
    - icon: fontawesome/brands/discord
      link: https://discord.gg/yT54ff6STY
  generator: false


markdown_extensions:
  - abbr
  - attr_list
  - def_list
  - footnotes
  - admonition
  - md_in_html
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - 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.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg