fastopenapi/mkdocs.yml at master · mr-fatalyst/fastopenapi · 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
site_name: FastOpenAPI
site_url: https://fastopenapi.fatalyst.dev/
site_description: FastOpenAPI is a library for generating and integrating OpenAPI schemas using Pydantic and various frameworks.
repo_name: mr-fatalyst/fastopenapi
repo_url: https://github.com/mr-fatalyst/fastopenapi
docs_dir: docs/

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: light green
      accent: light green
      toggle:
        icon: material/weather-night
        name: Switch to dark mode

    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: light green
      accent: light green
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
  - content.code.annotate
  - content.code.copy
  - content.footnote.tooltips
  - content.tabs.link
  - content.tooltips
  - navigation.footer
  - navigation.indexes
  - navigation.instant
  - navigation.instant.prefetch
  - navigation.instant.progress
  - navigation.path
  - navigation.tabs
  - navigation.tabs.sticky
  - navigation.top
  - navigation.tracking
  - search.highlight
  - search.share
  - search.suggest
  - toc.follow
  icon:
    repo: fontawesome/brands/github
  logo: img/favicon.png
  favicon: img/favicon.png
  language: en

nav:
  - Home: index.md

  - Getting Started:
      - Installation: getting_started/installation.md
      - Quickstart: getting_started/quickstart.md
      - Core Concepts: getting_started/core_concepts.md

  - User Guide:
      - Routing: guide/routing.md
      - Request Parameters: guide/request_parameters.md
      - Request Body: guide/request_body.md
      - Response Handling: guide/response_handling.md
      - Validation: guide/validation.md
      - Dependencies: guide/dependencies.md
      - Security: guide/security.md
      - Error Handling: guide/error_handling.md

  - Frameworks:
      - Overview: frameworks/overview.md
      - AIOHTTP: frameworks/aiohttp.md
      - Django: frameworks/django.md
      - Falcon: frameworks/falcon.md
      - Flask: frameworks/flask.md
      - Quart: frameworks/quart.md
      - Sanic: frameworks/sanic.md
      - Starlette: frameworks/starlette.md
      - Tornado: frameworks/tornado.md

  - Examples:
      - CRUD API: examples/crud_api.md
      - File Uploads: examples/file_uploads.md
      - Authentication: examples/authentication.md
      - Multi-Router Apps: examples/multi_router.md
      - Async Patterns: examples/async_tasks.md

  - Advanced:
      - Architecture: advanced/architecture.md
      - Architecture Quick Guide: advanced/architecture_quick_reference.md
      - Custom Routers: advanced/custom_routers.md
      - OpenAPI Customization: advanced/openapi_customization.md
      - Performance: advanced/performance.md
      - Testing: advanced/testing.md

  - API Reference:
      - Parameters: api_reference/parameters.md
      - Dependencies: api_reference/dependencies.md
      - Responses: api_reference/responses.md
      - Errors: api_reference/errors.md
      - Routers: api_reference/routers.md
      - Types: api_reference/types.md

  - Community:
      - Contributing: community/contributing.md
      - Changelog: community/changelog.md
      - FAQ: community/faq.md

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

extra_javascript:
  - https://unpkg.com/mermaid@10/dist/mermaid.min.js
  - javascripts/mermaid-init.js

extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/mr-fatalyst/fastopenapi
    - icon: fontawesome/brands/linkedin
      link: https://linkedin.com/in/nikita-ryzhenkov
    - icon: fontawesome/solid/envelope
      link: mailto:nikita.ryzhenkoff@gmail.com