docs/mkdocs.yml at master · uvicore/docs · 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
# Navigation
nav:
  - Uvicore: index.md
  - Features: features/index.md
  - Getting Started:
    - getting-started/installation.md
    - getting-started/directory-structure.md
    - getting-started/configuration.md
    # - getting-started/deployment.md
  - HTTP:
    - http/index.md
    - API:
      - http/api/routing.md
      - http/api/model-router.md
      - http/api/file-upload.md
    - Web:
      - http/web/routing.md
      - http/web/views.md
      - http/web/controllers.md
    - Exceptions:
      - http/exceptions/concepts.md
      - http/exceptions/handlers.md
      - http/exceptions/http-exception.md
      - http/exceptions/not-found.md
      - http/exceptions/permission-denied.md
      - http/exceptions/not-authenticated.md
      - http/exceptions/invalid-credentials.md
  - CLI:
    - cli/index.md
    - cli/commands.md
    - cli/writing-commands.md
    - cli/python-entrypoints.md
  - Database:
    - database/index.md
    - Database:
      - database/db-config.md
      - database/db-tables.md
      - database/db-migrations.md
      - database/db-queries.md
    - ORM:
      - database/orm-basics.md
      - database/orm-model.md
      - database/orm-querybuilder.md
      - database/orm-pydantic.md
  - Architecture:
    - service-providers.md
    - ioc.md
    - request-lifecycle.md
    - bootstrap.md
  - Digging Deeper:
    - events.md
    - jobs.md
    - cache.md
    - mail.md
    - auto-api.md
    - superdict.md
    - cli-entrypoints.md
  - Epologue:
    - epologue/release-notes.md
    - epologue/mkdocs-help.md
    - epologue/upgrade-0.1-to-0.2.md


site_name: Uvicore - Fullstack Async Python
site_description: The Fullstack Async Web, API and CLI Python Framework
site_url: https://uvicore.io
#copyright: Copyright 2024 Matthew Reschke

# Repository
repo_name: uvicore/framework
repo_url: https://github.com/uvicore/framework
edit_uri: ''

# Serving
dev_addr: '0.0.0.0:8034'


# Plugins
plugins:
  search: null
  # - tags Nah


# Markdown Extensions
markdown_extensions:
  extra: null
  admonition: null
  pymdownx.superfences: null
  pymdownx.details: null
  pymdownx.tabbed: null
  pymdownx.emoji:
    emoji_index: !!python/name:materialx.emoji.twemoji
    emoji_generator: !!python/name:materialx.emoji.to_svg
  pymdownx.tasklist:
    custom_checkbox: true
  footnotes: null
  attr_list: null
  md_in_html: null
  codehilite: null
  markdown.extensions.codehilite:
    guess_lang: false
      #use_pygments: true
      #noclasses: true
  meta: null
  # nl2br: null
  sane_lists: null
  toc:
    permalink: true


# Theme and Colors
theme:
  name: material
  palette:
    scheme: slate  # default or slate
    primary: blue
    accent: purple

  # Palette toggle is for Insiders only (paid)
  # - scheme: default  # default or slate
  #   primary: blue
  #   accent: purple
  #   toggle:
  #     icon: material/lightbulb-outline
  #     name: Light Theme
  # - scheme: slate
  #   primary: blue
  #   accent: purple
  #   toggle:
  #     icon: material/lightbulb-outline
  #     name: Dark Mode
  font:
    text: Roboto
    code: Roboto Mono
  #favicon: assets/favicon.png
  features:
    #- navigation.instant
    - navigation.tabs
  icon:
    logo: fontawesome/solid/code
    repo: fontawesome/brands/github
extra_css:
  #- style-dark.css # Set pygments_style: monokai
  #- style-light.css # Comment out pygments_style
  - files/style.css
extra_javascript:
  - files/custom.js

# Extra CSS and Javascript
#extra_css:
#- assets/css/termynal.css
#- assets/css/custom.css
#extra_javascript:
#- assets/js/termynal.js
#- assets/js/custom.js