pavex/mkdocs.yml at main · rust-lang-uz/pavex · 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
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
  - md_slash:TrailingSlashExtension
  - 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/index.md
              - guide/project_structure/app.md
              - guide/project_structure/server_sdk.md
              - guide/project_structure/server.md
          - "Attributes":
              - guide/attributes/index.md
              - guide/attributes/component_id.md
              - guide/attributes/functions_and_methods.md
              - guide/attributes/types.md
              - guide/attributes/sync_or_async.md
          - "Routing":
              - guide/routing/index.md
              - guide/routing/path_patterns.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
                  - guide/request_data/body/json.md
                  - guide/request_data/body/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/generics.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
          - "Configuration":
              - guide/configuration/index.md
              - guide/configuration/entries.md
              - guide/configuration/loading.md
              - guide/configuration/application_config.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
          - "Sessions":
              - guide/sessions/index.md
              - guide/sessions/installation.md
              - guide/sessions/data.md

  - "API Reference": api_reference/pavex/index.html
exclude_docs: |
  README.md
  Dockerfile
  .dockerignore
  tools/
  tutorials/
  examples/
extra_css:
  - ansi.css
  - mermaid.css
  - content_tab.css
validation:
  omitted_files: warn
  absolute_links: relative_to_docs
  unrecognized_links: warn
  anchors: warn
not_in_nav: |
  api_reference/*