mkdocs.yml

site_name: FastAPI Guard
site_description: Security middleware for FastAPI applications
site_url: https://rennf93.github.io/fastapi-guard/latest/
repo_name: rennf93/fastapi-guard
repo_url: https://github.com/rennf93/fastapi-guard
edit_uri: edit/master/docs/

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: dark-blue
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: dark-blue
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - content.code.annotate
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - search.highlight
    - search.share
    - toc.follow
  icon:
    repo: fontawesome/brands/github
  logo: assets/guard_core_logo.svg
  favicon: assets/guard_core_favicon.png

nav:
  - Home: index.md
  - Installation: installation.md
  - Tutorial - User Guide:
    - First Steps: tutorial/first-steps.md
    - Integration Guide: tutorial/integration.md
    - WebSockets: tutorial/websockets.md
    - IP Management:
      - IP Banning: tutorial/ip-management/banning.md
      - Geolocation: tutorial/ip-management/geolocation.md
      - Cloud Providers: tutorial/ip-management/cloud-providers.md
      - Rate Limiting: tutorial/ip-management/rate-limiter.md
    - Security Decorators:
      - Overview: tutorial/decorators/overview.md
      - Access Control: tutorial/decorators/access-control.md
      - Authentication: tutorial/decorators/authentication.md
      - Rate Limiting: tutorial/decorators/rate-limiting.md
      - Behavioral Analysis: tutorial/decorators/behavioral.md
      - Content Filtering: tutorial/decorators/content-filtering.md
      - Advanced Decorators: tutorial/decorators/advanced.md
    - Security Features:
      - Penetration Detection: tutorial/security/penetration-detection.md
      - HTTP Security Headers: tutorial/security/http-security-headers.md
      - Detection Engine:
        - Overview: tutorial/security/detection-engine/overview.md
        - Architecture: tutorial/security/detection-engine/architecture.md
        - Components: tutorial/security/detection-engine/components.md
        - Configuration: tutorial/security/detection-engine/configuration.md
        - Performance Tuning: tutorial/security/detection-engine/performance-tuning.md
      - Proxy Security: tutorial/security/proxy-security.md
      - Custom Patterns: tutorial/security/custom-patterns.md
      - Security Monitoring: tutorial/security/monitoring.md
      - Passive to Active: tutorial/security/passive-to-active.md
    - Configuration:
      - Security Config: tutorial/configuration/security-config.md
      - CORS: tutorial/configuration/cors.md
      - Logging: tutorial/configuration/logging.md
      - Telemetry: tutorial/configuration/telemetry.md
    - Redis Integration: tutorial/redis-integration/caching.md
    - Advanced Customizations: tutorial/advanced-customizations.md
    - Example App: tutorial/examples/example-app.md
  - API Reference:
    - Overview: api/overview.md
    - SecurityMiddleware: api/security-middleware.md
    - Core Architecture: api/core-architecture.md
    - SecurityDecorators: api/decorators.md
    - BehaviorManager: api/behavior-manager.md
    - RedisManager: api/redis-manager.md
    - IPBanManager: api/ipban-manager.md
    - IPInfoManager: api/ipinfo-manager.md
    - RateLimitManager: api/ratelimit-manager.md
    - SusPatternsManager: api/sus-patterns.md
    - CloudManager: api/cloud-manager.md
    - SecurityHeadersManager: api/security-headers.md
    - Utilities: api/utilities.md
  - Examples:
    - Example App: tutorial/examples/example-app.md
  - Release Notes: release-notes.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: true
  - attr_list
  - md_in_html
  - def_list

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [guard, .]
          options:
            show_source: true
            show_root_heading: true
            heading_level: 2
            docstring_style: google
            show_if_no_docstring: true
            filters: ["!^_"]
            merge_init_into_class: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/rennf93/fastapi-guard
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/fastapi-guard/

  analytics:
    provider: custom

  generator: false
  meta:
    - property: og:type
      content: website
    - property: og:title
      content: FastAPI Guard - Security Middleware for FastAPI
    - property: og:description
      content: Comprehensive security library for FastAPI applications providing IP control, request logging, and penetration detection
    - property: og:image
      content: https://rennf93.github.io/fastapi-guard/latest/assets/fastapi_guard_legend.svg
    - name: keywords
      content: fastapi, security, middleware, python, ip control, rate limiting, penetration detection

  version:
    provider: mike
    default: latest
    version_selector: true
    json_file: /fastapi-guard/versions.json

  author:
    name: Renzo Franceschini
    url: https://github.com/rennf93

copyright: FastAPI Guard by

extra_css:
  - css/custom.css