mkdocs.yml

site_name: Pavex
site_url: "https://pavex.dev/"
site_description: "The documentation for Pavex, a framework for building robust APIs in Rust."
repo_url: "https://github.com/LukeMathWalker/pavex"
repo_name: "LukeMathWalker/pavex"
edit_uri: "edit/main/docs/"
plugins:
  #  - social
  - search
  - redirects:
      redirect_maps:
        "index.md": "overview/index.md"
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      check_paths: true
      dedent_subsections: true
  - attr_list
  - md_in_html
  - footnotes
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
theme:
  name: material
  logo: assets/inverted_logo.png
  favicon: assets/logo.ico
  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
  features:
    - content.action.edit
    - content.code.copy
    - content.code.annotate
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - toc.follow
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: black
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      primary: black
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
nav:
  - "Welcome":
      - overview/index.md
      - overview/why_pavex.md
  - "Getting Started":
      - "Installation": getting_started/index.md
      - getting_started/learning_paths.md
      - "Quickstart tutorial":
          - getting_started/quickstart/index.md
          - getting_started/quickstart/blueprint.md
          - getting_started/quickstart/routing.md
          - getting_started/quickstart/dependency_injection.md
          - getting_started/quickstart/error_handling.md
          - getting_started/quickstart/testing.md
          - getting_started/quickstart/going_further.md
  - "Guide":
      - guide/index.md
      - "Fundamentals":
          - "Project structure": guide/project_structure.md
          - "Routing":
              - guide/routing/index.md
              - guide/routing/method_guards.md
              - guide/routing/path_patterns.md
              - guide/routing/request_handlers.md
              - guide/routing/path_prefixes.md
              - guide/routing/domain_guards.md
          - "Request data":
              - guide/request_data/index.md
              - guide/request_data/wire_data.md
              - guide/request_data/request_target.md
              - "Connection Info": guide/request_data/connection_info.md
              - "Path":
                  - guide/request_data/path/index.md
                  - guide/request_data/path/path_parameters.md
                  - guide/request_data/path/raw_path_parameters.md
              - "Query":
                  - guide/request_data/query/index.md
                  - guide/request_data/query/query_parameters.md
              - "Body":
                  - guide/request_data/body/index.md
                  - "Deserializers":
                      - guide/request_data/body/deserializers/index.md
                      - guide/request_data/body/deserializers/json.md
                      - guide/request_data/body/deserializers/url_encoded.md
                  - guide/request_data/body/byte_wrappers.md
          - "Dependency injection":
              - guide/dependency_injection/index.md
              - guide/dependency_injection/framework_primitives.md
              - guide/dependency_injection/constructors.md
              - guide/dependency_injection/prebuilt_types.md
              - guide/dependency_injection/application_state.md
              - guide/dependency_injection/kits.md
              - guide/dependency_injection/cookbook.md
              - guide/dependency_injection/limitations.md
          - "Middlewares":
              - guide/middleware/index.md
              - guide/middleware/pre_processing.md
              - guide/middleware/post_processing.md
              - guide/middleware/wrapping.md
              - guide/middleware/scoping.md
              - guide/middleware/execution_order.md
          - "Errors":
              - guide/errors/index.md
              - guide/errors/error_handlers.md
              - guide/errors/error_observers.md
      - "Digging deeper":
          - "Cookies":
              - guide/cookies/index.md
              - guide/cookies/installation.md
              - guide/cookies/request_cookies.md
              - guide/cookies/response_cookies.md

  - "API Reference": api_reference/pavex/
exclude_docs: |
  README.md
  Dockerfile
extra_css:
  - ansi.css
  - mermaid.css
  - content_tab.css