resumable-upload/mkdocs.yml at main · injaeryou/resumable-upload · 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
site_name: Resumable Upload
site_description: Python TUS resumable upload protocol — server and client
site_url: https://injaeryou.github.io/resumable-upload/
repo_url: https://github.com/injaeryou/resumable-upload
repo_name: injaeryou/resumable-upload
edit_uri: edit/main/docs/

theme:
  name: material
  language: en
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.highlight
    - search.suggest
    - content.code.copy
    - content.action.edit

plugins:
  - search
  - git-revision-date-localized:
      enable_creation_date: true
      type: date

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.inlinehilite
  - admonition
  - pymdownx.details
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Advanced Usage:
      - Retry & Error Handling: advanced-usage/retry.md
      - Resume & Partial Uploads: advanced-usage/resume.md
      - Concatenation & Parallel Uploads: advanced-usage/concatenation.md
      - Observability & Retry Gating: advanced-usage/observability.md
      - Low-Level Uploader: advanced-usage/uploader.md
  - Web Frameworks:
      - Flask: web-frameworks/flask.md
      - FastAPI: web-frameworks/fastapi.md
      - Django: web-frameworks/django.md
      - ASGI (generic): web-frameworks/asgi.md
  - Operations:
      - CLI: operations/cli.md
      - Metrics: operations/metrics.md
      - Distributed Locks: operations/locks.md
  - API Reference:
      - Client: api-reference/client.md
      - Server: api-reference/server.md
      - Storage: api-reference/storage.md
      - Exceptions & Utilities: api-reference/exceptions.md
  - TUS Compliance: compliance.md