forked from Neoteroi/BlackSheep-Docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
112 lines (106 loc) · 3.08 KB
/
mkdocs.yml
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
site_name: BlackSheep
site_author: Roberto Prevato
site_description: The official documentation website of BlackSheep, a fast ASGI web framework for Python asyncio.
site_url: https://www.neoteroi.dev/blacksheep/
repo_name: Neoteroi/BlackSheep
repo_url: https://github.com/Neoteroi/BlackSheep
edit_uri: ""
nav:
- Overview: index.md
- "Getting started: basics": getting-started.md
- "Getting started: MVC": mvc-project-template.md
- Dependency injection: dependency-injection.md
- OpenAPI Docs: openapi.md
- Application: application.md
- Routing: routing.md
- Request handlers: request-handlers.md
- Requests: requests.md
- Responses: responses.md
- Testing: testing.md
- Templating: templating.md
- Controllers: controllers.md
- Middlewares: middlewares.md
- WebSocket: websocket.md
- Serving static files: static-files.md
- Authentication: authentication.md
- Authorization: authorization.md
- OpenID Connect: openid-connect.md
- Sessions: sessions.md
- Security:
- CORS: cors.md
- Anti-Forgery: anti-request-forgery.md
- Data protection: dataprotection.md
- HSTS: hsts.md
- Remotes: remotes.md
- Response features:
- Cache control: cache-control.md
- Compression: compression.md
- Examples:
- Using Marshmallow: examples/marshmallow.md
- Settings: settings.md
- Binders: binders.md
- Background tasks: background-tasks.md
- Mounting apps: mounting.md
- HTTP Client: client.md
- More about the CLI: cli.md
- From V1 to V2: versions/migrating-to-v2.md
- Develop using HTTPS: develop-with-https.md
- ASGI: asgi.md
- Extensions: extensions.md
- Contributing: contributing.md
- About: about.md
- Neoteroi docs home: "/"
theme:
features:
- navigation.footer
- content.code.copy
- content.action.view
palette:
- scheme: slate
toggle:
icon: material/toggle-switch
name: Switch to light mode
- scheme: default
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
name: "material"
custom_dir: overrides/
highlightjs: true
favicon: img/favicon.ico
logo: img/logow.svg
icon:
repo: fontawesome/brands/github
extra:
version: 2
is_current_version: true
extra_css:
- css/neoteroi.css
- css/extra.css?v=20221120
plugins:
- search
- neoteroi.contribs:
contributors:
- email: [email protected]
image: https://avatars.githubusercontent.com/u/2576032?s=400&u=d8d880e8ed05bb170877dd3d561d8301c4beeeed&v=4
markdown_extensions:
- admonition
- markdown.extensions.codehilite:
guess_lang: false
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tabbed:
alternate_style: true
- toc:
permalink: true
- neoteroi.timeline
- neoteroi.cards
- neoteroi.projects
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg