uvicorn/mkdocs.yml at main · Kludex/uvicorn · 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
site_name: Uvicorn
site_description: The lightning-fast ASGI server.
site_url: https://uvicorn.dev

repo_name: Kludex/uvicorn
repo_url: https://github.com/Kludex/uvicorn
edit_uri: edit/main/docs/

strict: true

theme:
  name: material
  custom_dir: docs/overrides
  logo: uvicorn.png
  favicon: uvicorn.png
  palette:
    - scheme: "default"
      media: "(prefers-color-scheme: light)"
      toggle:
        icon: "material/lightbulb"
        name: "Switch to dark mode"
    - scheme: "slate"
      media: "(prefers-color-scheme: dark)"
      primary: "blue"
      toggle:
        icon: "material/lightbulb-outline"
        name: "Switch to light mode"
  icon:
    repo: fontawesome/brands/github
  features:
    - content.code.annotate
    - content.code.copy # https://squidfunk.github.io/mkdocs-material/upgrade/?h=content+copy#contentcodecopy
    - content.tabs.link
    - navigation.footer # https://squidfunk.github.io/mkdocs-material/upgrade/?h=content+copy#navigationfooter
    - navigation.path
    - navigation.sections # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation
    - navigation.top # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#back-to-top-button
    - navigation.tracking
    - search.suggest
    - search.highlight
    - toc.follow # https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#anchor-following

# https://www.mkdocs.org/user-guide/configuration/#validation
validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

nav:
  - Welcome: index.md
  - Installation: installation.md
  - Settings: settings.md
  - Server Behavior: server-behavior.md
  - Concepts:
      - ASGI: concepts/asgi.md
      - Lifespan: concepts/lifespan.md
      - Logging: concepts/logging.md
      - WebSockets: concepts/websockets.md
      - Event Loop: concepts/event-loop.md
  - Deployment:
      - Deployment: deployment/index.md
      - Docker: deployment/docker.md
  - Release Notes: release-notes.md
  - Contributing: contributing.md
  - Sponsorship: sponsorship.md

extra:
  analytics:
    provider: google
    property: G-KTS6TXPD85
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/Kludex/uvicorn
    - icon: fontawesome/brands/discord
      link: https://discord.com/invite/RxKUF5JuHs
    - icon: fontawesome/brands/twitter
      link: https://x.com/marcelotryle
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/marcelotryle
    - icon: fontawesome/solid/globe
      link: https://fastapiexpert.com

markdown_extensions:
  - attr_list
  - admonition
  - codehilite:
      css_class: highlight
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.extra:
      pymdownx.superfences:
        custom_fences:
          - name: mermaid
            class: mermaid
            format: !!python/name:pymdownx.superfences.fence_code_format

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          inventories:
            - https://docs.python.org/3/objects.inv
  - llmstxt:
      full_output: llms-full.txt
      markdown_description: |-
        Uvicorn is a lightning-fast ASGI server implementation, designed to run asynchronous web applications.
        It supports the ASGI specification, which allows for both HTTP/1.1 and WebSocket protocols.
      sections:
        Sections:
          - index.md
          - settings.md
          - deployment/*.md
          - server-behavior.md
        Concepts:
          - concepts/*.md

hooks:
  - docs/plugins/main.py