EasySwitch/mkdocs.yml at master · julienho-ops/EasySwitch · 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
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
site_name: EasySwitch SDK
site_url: https://your-docs-url.com
repo_url: https://github.com/AllDotPy/EasySwitch
repo_name: EasySwitch

theme:
  name: material

  # LOGO AND FAVICON
  logo: assets/logo/dotpy_blue_transparent.png
  favicon: assets/logo/dotpy_blue_transparent.png
  language: en
  features:
    # - navigation.tabs
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.path
    - navigation.indexes
    - navigation.top
    - navigation.tabs
    - navigation.sections
    - navigation.tracking
    - navigation.prune

    # - toc.integrate
    - toc.follow

    # SEARCH
    - search.suggest
    - search.highlight

    # CODE
    - code.copy
    - code.annotate
    - code.tabs
    - code.expand
    - content.code.copy
    - content.code.select

    # CONTENT ACTIONS
    - content.action.edit
    - content.action.view

  # PALETTE
  palette:
    - scheme: slate
      primary: indigo
      accent: light blue

  # FONTS
  font:
    text: Inter
    code: Chivo Mono

# Extra JS files
extra_javascript:
  - assets/javascript/msdl.v1.js
  - assets/javascript/init_kapa_widget.v2.js

# Extra CSS files
extra_css:
  - assets/stylesheets/msdl.v2.css
  - assets/stylesheets/theme.v3.css

# NAVIGATION
# nav_translations:
nav:
  # # English translations
  # en:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Configuration: getting-started/configuration.md
  # - Guides:
  #     - Payments: guides/payments.md
  #     - Webhooks: guides/webhooks.md
  #     - Error Handling: guides/error-handling.md
  - Integrations:
      - FedaPay: integrations/fedapay.md
      - PayGate: integrations/paygate.md
      - CinetPay: integrations/cinetpay.md
      - Semoa: integrations/semoa.md
      - Bizao: integrations/bizao.md
  - API Reference:
      - Shared types: api-reference/shared-types.md
      - Configuration types: api-reference/config-types.md
      - Exceptions: api-reference/exceptions.md
      - Base Adapter: api-reference/base-adapter.md
  - Contributing: contributing.md

  # French translations
  # fr:
  #   - Accueil: index.md
  #   - Démarrage:
  #       - Installation: getting-started/installation.md
  #       - Configuration: getting-started/configuration.md
  #   - Guides:
  #       - Paiements: guides/payments.md
  #       - Webhooks: guides/webhooks.md
  #       - Gestion des erreurs: guides/error-handling.md
  #   - Référence API: api-reference.md
  #   - Contribuer: contributing.md

markdown_extensions:
  - admonition
  - codehilite
  - footnotes
  - tables
  - toc:
      permalink: true
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.tabbed
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      # Use Twemoji for emojis
      # This is the default, but explicitly specifying for clarity
      # emoji_index: !!python/name:material.extensions.emoji.twemoji
      # emoji_generator: !!python/name:material.extensions.emoji.to_svg

  #
  - abbr
  - attr_list
  - md_in_html

plugins:
  - search
  # - i18n:
  #     default_language: en
  #     languages:
  #       - locale: en
  #         name: English
  #         default: true
  #         build: true
  #       - locale: fr
  #         name: Français
  #         default: false
  #         build: true

  # - macros:
      # on_error_fail: true
      # include_dir: includes

# Extra metadata
extra:
  version: 1.0.0
  description: Documentation for the EasySwitch SDK, a Python library for easy payment integration.

  social:
    - icon: fontawesome/brands/github
      link: https://github.com/AllDotPy/easyswitch
      name: EasySwitch on GitHub
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/AllDotPy
      name: EasySwitch on X