palfrey/mkdocs.yaml at main · dymmond/palfrey · 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
site_name: Palfrey
site_description: A clean-room, high-performance ASGI server for Python.
site_url: https://palfrey.dymmond.com
repo_name: dymmond/palfrey
repo_url: https://github.com/dymmond/palfrey
edit_uri: ''
strict: true
docs_dir: docs/generated
site_dir: site
theme:
  name: material
  language: en
  icon:
    logo: material/speedometer
    repo: fontawesome/brands/github
  palette:
  - scheme: default
    media: '(prefers-color-scheme: light)'
    primary: teal
    accent: amber
    toggle:
      icon: material/weather-night
      name: Switch to dark mode
  - scheme: slate
    media: '(prefers-color-scheme: dark)'
    primary: cyan
    accent: lime
    toggle:
      icon: material/weather-sunny
      name: Switch to light mode
  favicon: statics/images/favicon.ico
  logo: statics/images/white.png
  font:
    text: Source Sans 3
    code: JetBrains Mono
  features:
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.copy
    - content.code.annotate
    - content.tooltips
    - content.code.select
    - navigation.indexes
    - navigation.path
    - navigation.tabs

plugins:
- search
- meta-descriptions:
    export_csv: false
    quiet: false
    enable_checks: false
    min_length: 50
    max_length: 160
    trim: false
nav:
- Introduction: index.md
- Getting Started:
  - Installation: getting-started/installation.md
  - Quickstart: getting-started/quickstart.md
- Concepts:
  - Terms and Mental Models: concepts/terms-and-mental-models.md
  - ASGI Fundamentals: concepts/asgi.md
  - Event Loop: concepts/event-loop.md
  - HTTP: concepts/http.md
  - WebSockets: concepts/websockets.md
  - Lifespan: concepts/lifespan.md
  - Middleware: concepts/middleware.md
  - Server Behavior: concepts/server-behavior.md
- Reference:
  - CLI: reference/cli.md
  - Configuration: reference/configuration.md
  - Environment Variables: reference/environment-variables.md
  - Protocols: reference/protocols.md
  - Logging: reference/logging.md
  - Error Catalog: reference/error-catalog.md
- Guides:
  - Zero to Production: guides/from-zero-to-production.md
  - Reverse Proxy (Nginx): guides/reverse-proxy-nginx.md
  - HTTPS and TLS: guides/https-tls.md
  - Security Hardening: guides/security-hardening.md
  - Troubleshooting: guides/troubleshooting.md
  - FAQ: guides/faq.md
- Operations:
  - Deployment: operations/deployment.md
  - Docker: operations/docker.md
  - Reload: operations/reload.md
  - Workers: operations/workers.md
  - Observability: operations/observability.md
  - Capacity Planning: operations/capacity-planning.md
  - Platform Notes: operations/platform-notes.md
  - Benchmarks: operations/benchmarks.md
  - Release Process: operations/release-process.md
- Contributing: contributing.md
- Release Notes: release-notes.md
- Sponsorship: sponsorship.md

markdown_extensions:
  - toc:
      permalink: true
  - admonition
  - pymdownx.highlight:
      use_pygments: true
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html

extra_css:
- stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/dymmond/palfrey
    - icon: fontawesome/brands/discord
      link: https://discord.gg/XVeWXSrJ