APIException/mkdocs.yml at main · akutayural/APIException · 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
site_name: APIException
site_description: Professional, robust, and extensible exception handling & response standardization for FastAPI.
site_author: Ahmet Kutay Ural
site_url: https://ahmetkutayural.dev

repo_name: akutayural/APIException
repo_url: https://github.com/akutayural/APIException
edit_uri: edit/main/docs/

theme:
  name: material
  language: en

  icon:
    logo: docs/logo.png
    repo: fontawesome/brands/github
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - toc.integrate
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
    - content.action.edit
  palette:
    - scheme: default
      primary: custom
      accent: amber
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      primary: custom
      accent: amber
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

  custom_dir: docs/overrides

  logo: assets/logo.png
  favicon: favicon/favicon.ico

  font:
    text: Inter
    code: Fira Code

extra_css:
  - assets/styles.css
  - overrides/stylesheets/extra.css


markdown_extensions:
  - admonition
  - toc:
      permalink: true
  - codehilite
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.details
  - pymdownx.tabbed
  - pymdownx.snippets
  - attr_list

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/akutayural
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/akutayural/
    - icon: fontawesome/solid/globe
      link: https://ahmetkutayural.dev
  generator: false

plugins:
  - search
  - awesome-pages
  - macros

nav:
  - APIException: index.md
  - 🚀 Installation: installation.md
  - ⚡ Quick Start: usage/quick_start.md
  - 🧩 Usage:
      - register_exception_handlers: usage/register_exception_handlers.md
      - Response Model: usage/response_model.md
      - Base Exception Code: usage/custom_codes.md
      - Fallback Middleware: usage/fallback.md
  - 📚 Advanced:
      - Swagger Integration: advanced/swagger.md
      - Logging & Debug: advanced/logging.md
      - RFC 7807 Integration: advanced/rfc7807.md
  - 📂 Examples: examples.md
  - 🔗 API Reference: reference/api.md
  - 📝 Changelog: changelog.md