BustAPI/mkdocs.yml at main · RUSTxPY/BustAPI · 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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
site_name: BustAPI
site_description: "The fastest Python web framework. Flask-like API with Rust-powered performance. 100,000+ requests/sec."
site_author: GrandpaEJ
site_url: https://RUSTxPY.github.io/BustAPI/
repo_url: https://github.com/RUSTxPY/BustAPI
repo_name: RUSTxPY/BustAPI
edit_uri: edit/main/docs/

copyright: |
  Copyright &copy; 2025 GrandpaEJ –
  Made with ❤️ and Rust 🦀

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/RUSTxPY/BustAPI
      name: BustAPI on GitHub
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/bustapi/
      name: BustAPI on PyPI
    - icon: fontawesome/solid/heart
      link: https://ej.grandpaacademy.org/
      name: Sponsor BustAPI
  generator: false
  analytics:
    provider: google
    property: G-XXXXXXXXXX
  version:
    provider: mike

extra_css:
  - stylesheets/extra.css

theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/logo.png
  favicon: assets/logo.png
  language: en

  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/weather-night
        name: Switch to light mode

  font:
    text: Inter
    code: JetBrains Mono

  icon:
    repo: fontawesome/brands/github
    admonition:
      note: fontawesome/solid/note-sticky
      tip: fontawesome/solid/lightbulb
      warning: fontawesome/solid/triangle-exclamation
      danger: fontawesome/solid/skull
      example: fontawesome/solid/flask

  features:
    # Navigation
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - navigation.footer

    # Table of Contents
    - toc.follow
    - toc.integrate

    # Search
    - search.suggest
    - search.highlight
    - search.share

    # Content
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - content.tooltips

    # Header
    - header.autohide
    - announce.dismiss

plugins:
  - search:
      separator: '[\s\-\.]+'
      lang: en
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            show_object_full_path: false
            heading_level: 3

markdown_extensions:
  # Code Highlighting
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
      auto_title: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format # Content

  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.smartsymbols

  # Formatting
  - attr_list
  - md_in_html
  - tables
  - footnotes
  - abbr
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
  - 🏠 Home: index.md
  - 🚀 Getting Started:
      - Installation: installation.md
      - Quickstart: quickstart.md
  - 📖 Core Concepts:
      - Routing: user-guide/routing.md
      - Turbo Routes: user-guide/turbo-routes.md
      - Request Data: user-guide/request_data.md
      - Responses: user-guide/responses.md
      - Sessions: user-guide/sessions.md
      - Logging: user-guide/logging.md
      - Video Streaming: user-guide/video-streaming.md
      - WebSockets: websockets.md
      - Templates: user-guide/templates.md
  - ⚡ Performance:
      - Multiprocessing: user-guide/multiprocessing.md
      - Response Caching: user-guide/caching.md
  - 🔐 Authentication:
      - JWT Authentication: user-guide/jwt.md
      - Session Auth: user-guide/authentication.md
  - 🔧 Advanced:
      - Blueprints: advanced/blueprints.md
      - Middleware: advanced/middleware.md
      - Dependency Injection: advanced/dependency_injection.md
      - Validation: advanced/validation.md
      - Async Support: advanced/async.md
      - Security: advanced/security.md
      - Deployment: advanced/deployment.md
  - 📚 Reference:
      - API Reference: api-reference.md
      - Changelog: changelog.md
  - 💡 Examples:
      - Gallery: examples-guide.md