HawkAPI/mkdocs.yml at main · Hawk-API/HawkAPI · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
site_name: HawkAPI
site_description: High-performance Python web framework
site_url: https://hawkapi.ashimov.com
repo_url: https://github.com/Hawk-API/HawkAPI
repo_name: Hawk-API/HawkAPI

theme:
  name: material
  palette:
    - scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - content.code.annotate
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - toc.follow

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
  - Guide:
      - Routing: guide/routing.md
      - Responses: guide/responses.md
      - Dependency Injection: guide/dependency-injection.md
      - Middleware: guide/middleware.md
      - Security: guide/security.md
      - Permissions: guide/permissions.md
      - Versioning: guide/versioning.md
      - Observability: guide/observability.md
      - WebSockets: guide/websockets.md
      - Static Files: guide/static-files.md
      - Configuration: guide/configuration.md
      - Testing: guide/testing.md
      - Deployment: guide/deployment.md
      - HTTP/2 and HTTPS: guide/http2.md
      - Performance: guide/performance.md
      - Benchmarks: guide/benchmarks.md
      - Client codegen: guide/client-codegen.md
      - Feature flags: guide/feature-flags.md
      - GraphQL: guide/graphql.md
      - gRPC: guide/grpc.md
      - Bulkhead: guide/bulkhead.md
      - Free-threaded Python (PEP 703): guide/free-threaded.md
      - Migration from FastAPI: guide/migration-from-fastapi.md
      - Doctor: guide/doctor.md
      - Official plugins: guide/plugins.md
  - API Reference: api/index.md

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - attr_list
  - toc:
      permalink: true

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: false
            show_root_heading: true
            heading_level: 3