mkdocs.yml

site_name: FasterAPI
site_description: High-performance ASGI web framework for Python
site_url: https://fasterapiweb.github.io/FasterAPI/
repo_url: https://github.com/FasterApiWeb/FasterAPI
repo_name: FasterApiWeb/FasterAPI
edit_uri: edit/master/docs/
site_author: Eshwar Chandra Vidhyasagar Thedla

# Project pages live under /FasterAPI/; site_url must match Settings → Pages URL.
use_directory_urls: true

theme:
  name: material
  custom_dir: docs/overrides
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.expand
    - navigation.sections
    - navigation.top
    - navigation.footer
    - navigation.indexes
    - content.code.copy
    - content.code.annotate
    - content.action.edit
    - content.action.view
    - toc.follow
    - search.highlight
    - search.suggest
    - search.share

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Tutorial:
      - Overview: tutorial/index.md
      - Path Parameters: tutorial/path-parameters.md
      - Query Parameters: tutorial/query-parameters.md
      - Request Body: tutorial/request-body.md
      - Response Model: tutorial/response-model.md
      - Form Data & File Uploads: tutorial/form-and-files.md
      - Error Handling: tutorial/error-handling.md
      - Dependencies: tutorial/dependencies.md
      - Background Tasks: tutorial/background-tasks.md
      - Middleware: tutorial/middleware.md
      - WebSockets: tutorial/websockets.md
      - Metadata & Docs: tutorial/metadata.md
  - Advanced User Guide:
      - Overview: advanced/index.md
      - Custom Response Classes: advanced/custom-response.md
      - Response Cookies & Headers: advanced/response-cookies-headers.md
      - Using the Request: advanced/using-request.md
      - Settings & Env Vars: advanced/settings.md
      - OpenAPI Customisation: advanced/openapi-customization.md
      - Additional Responses: advanced/additional-responses.md
      - Templates (Jinja2): advanced/templates.md
      - Lifespan Events: advanced/lifespan.md
      - Behind a Proxy: advanced/behind-proxy.md
      - Sub-applications: advanced/sub-applications.md
      - Server-Sent Events: advanced/server-sent-events.md
      - Testing with Overrides: advanced/testing-overrides.md
      - Async Tests: advanced/async-tests.md
      - Bigger Applications: advanced/bigger-apps.md
  - Security:
      - Introduction: security/index.md
      - OAuth2 + JWT: security/oauth2-jwt.md
      - OAuth2 Scopes: security/oauth2-scopes.md
      - HTTP Basic Auth: security/http-basic-auth.md
  - Databases:
      - Overview: database/index.md
      - SQL with SQLAlchemy: database/sqlalchemy.md
      - NoSQL — MongoDB: database/nosql-mongodb.md
      - Async Database Usage: database/async-db.md
  - Deployment:
      - Overview: deployment/index.md
      - Docker: deployment/docker.md
      - systemd Service: deployment/systemd.md
      - Gunicorn + Uvicorn: deployment/gunicorn.md
      - HTTPS — Let's Encrypt: deployment/https.md
      - Nginx & Traefik: deployment/nginx-traefik.md
      - Cloud Services: deployment/cloud.md
      - Kubernetes: deployment/kubernetes.md
  - Concepts:
      - Async / Await: concepts/async-await.md
      - Concurrency & Parallelism: concepts/concurrency.md
      - Python Type Hints: concepts/types-intro.md
      - msgspec vs Pydantic: concepts/msgspec-vs-pydantic.md
      - Radix Tree Routing: concepts/radix-tree-routing.md
      - Sub-Interpreters Guide: concepts/sub-interpreters.md
  - How-To Recipes: how-to/index.md
  - Reference:
      - API Reference: api-reference.md
      - Architecture: architecture.md
      - Benchmarks: benchmarks.md
      - Benchmark Methodology: benchmark-methodology.md
      - Migrating from FastAPI: migration-from-fastapi.md
      - Python 3.13 & Compatibility: python-313.md
      - Changelog: changelog.md
      - Acknowledgments: acknowledgments.md
  - FAQ & Troubleshooting: faq.md

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.snippets
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - admonition
  - pymdownx.details
  - toc:
      permalink: true
  - attr_list
  - md_in_html
  - tables
  - footnotes

extra:
  version:
    provider: mike
    default: stable
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/FasterApiWeb/FasterAPI
      name: Source on GitHub
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/faster-api-web/
      name: PyPI faster-api-web

plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - mike:
      alias_type: symlink
      canonical_version: latest
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            heading_level: 2