asyncer/mkdocs.yml at main · fastapi/asyncer · 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
INHERIT: ./mkdocs.env.yml
site_name: Asyncer
site_description: Asyncer, async and await, focused on developer experience.
site_url: https://asyncer.tiangolo.com/
theme:
  variant: classic
  name: material
  palette:
  - media: "(prefers-color-scheme)"
    toggle:
      icon: material/lightbulb-auto
      name: Switch to light mode
  - media: '(prefers-color-scheme: light)'
    scheme: default
    primary: orange
    accent: indigo
    toggle:
      icon: material/lightbulb
      name: Switch to dark mode
  - media: '(prefers-color-scheme: dark)'
    scheme: slate
    primary: orange
    accent: indigo
    toggle:
      icon: material/lightbulb-outline
      name: Switch to system preference
  features:
  - content.code.annotate
  - content.code.copy
  # - content.code.select
  - content.footnote.tooltips
  - content.tabs.link
  - content.tooltips
  - navigation.footer
  - navigation.indexes
  - navigation.instant
  - navigation.instant.prefetch
  # - navigation.instant.preview
  - navigation.instant.progress
  - navigation.path
  - navigation.tabs
  - navigation.tabs.sticky
  - navigation.top
  - navigation.tracking
  - search.highlight
  - search.share
  - search.suggest
  - toc.follow

  icon:
    repo: octicons/mark-github-24
  logo: img/icon-white.svg
  favicon: img/favicon.png
  language: en
repo_name: fastapi/asyncer
repo_url: https://github.com/fastapi/asyncer

nav:
  - Asyncer: index.md
  - "":
    - tutorial/index.md
    - tutorial/install.md
    - tutorial/first-steps.md
    - tutorial/runnify.md
    - tutorial/soonify.md
    - tutorial/soonify-return.md
    - tutorial/asyncify.md
    - tutorial/syncify.md
    - tutorial/syncify-no-raise.md
  - "":
    - resources/index.md
    - help.md
    - contributing.md
  - "":
    - about/index.md
    - management.md
  - release-notes.md

markdown_extensions:
  # Zensical
  zensical.extensions.macros:
  # Material for MkDocs
  material.extensions.preview:
    targets:
      include:
        - "*"
  # Python Markdown
  abbr:
  attr_list:
  footnotes:
  md_in_html:
  tables:
  toc:
    permalink: true

  # Python Markdown Extensions
  pymdownx.betterem:
    smart_enable: all
  pymdownx.caret:
  pymdownx.highlight:
    line_spans: __span
  pymdownx.inlinehilite:
  pymdownx.keys:
  pymdownx.mark:
  pymdownx.superfences:
    custom_fences:
    - name: mermaid
      class: mermaid
      format: !!python/name:pymdownx.superfences.fence_code_format
  pymdownx.tilde:
  markdown_include_variants: null

  # pymdownx blocks
  pymdownx.blocks.admonition:
  pymdownx.blocks.details:
  pymdownx.blocks.tab:
    alternate_style: True

  # Other extensions
  mdx_include:

extra:
  social:
    - icon: octicons/mark-github-24
      link: https://github.com/fastapi/asyncer
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/tiangolo
    - icon: fontawesome/brands/bluesky
      link: https://bsky.app/profile/tiangolo.com
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/tiangolo
    - icon: fontawesome/solid/globe
      link: https://tiangolo.com

extra_css:
  - css/termynal.css
  - css/custom.css

extra_javascript:
  - js/termynal.js
  - js/custom.js

validation:
  unresolved_references: false