faststore/mkdocs.yml at master · Ichinga-Samuel/faststore · 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
site_name: filestore
site_url: https://ichinga-samuel.github.io/faststore
site_description: Production-ready file upload toolkit for FastAPI
site_author: Ichinga Samuel

repo_name: Ichinga-Samuel/faststore
repo_url: https://github.com/Ichinga-Samuel/faststore

copyright: Copyright &copy; 2024 – 2026 Ichinga Samuel

theme:
  name: material
  language: en
  icon:
    repo: fontawesome/brands/github
    logo: material/cloud-upload
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.footer
    - navigation.indexes
    - toc.follow
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tabs.link

nav:
  - Home: index.md
  - Getting Started:
      - getting-started/index.md
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
  - User Guide:
      - guide/index.md
      - Storage Backends: guide/backends.md
      - Validation: guide/validation.md
      - Callbacks: guide/callbacks.md
      - Multi-Field Uploads: guide/multi-field.md
      - Reading Results: guide/results.md
      - Error Handling: guide/errors.md
  - API Reference:
      - api/index.md
      - FileStore: api/filestore.md
      - Config: api/config.md
      - FileField: api/filefield.md
      - FileData: api/filedata.md
      - Store: api/store.md
      - Storage Engines: api/engines.md
      - Exceptions: api/exceptions.md
  - Examples:
      - examples/index.md
      - User Avatars: examples/avatars.md
      - Document Upload Service: examples/documents.md
      - Image Processing Pipeline: examples/image-pipeline.md
  - Configuration: configuration.md
  - Changelog: changelog.md

plugins:
  - search

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Ichinga-Samuel/faststore
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/filestore
  generator: false