mkdocs.yml

site_name: Korapay Client Documentation
site_description: A developer-friendly python client SDK for Korapay
site_author: Gbenga Adeyi
remote_name: gray-adeyi/korapay_client
repo_url: https://github.com/gray-adeyi/korapay_client
theme:
  name: material
  logo: assets/korapay-favicon.svg
  favicon: assets/korapay-favicon.svg
  font:
    text: "Open Sans"
    code: "Source Code Pro"
  language: en
  palette:

    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default


      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

  icon:
    repo: fontawesome/brands/github
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tabs
    - navigation.top
    - navigation.sections
    - navigation.path
    - navigation.indexes
    - navigation.footer
    - search.suggest
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.select


plugins:
  - mike:
      alias_type: symlink
      redirect_template: null
      deploy_prefix: ''
      canonical_version: latest
      version_selector: true
      css_dir: css
      javascript_dir: js
  - search
  - mkdocstrings
  - glightbox
extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/gray-adeyi/korapay_client



markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg


nav:
  - Home: index.md
  - "Get Started": get-started.md
  - Examples: examples.md
  - "API Reference":
      - Clients:
          - Introduction: api_reference/clients/index.md
          - KorapayClient: api_reference/clients/sync_client.md
          - AsyncKorapayClient: api_reference/clients/async_client.md
      - Models: api_reference/models.md
      - Enums: api_reference/enums.md
      - Exceptions: api_reference/exceptions.md
  - FAQs: faqs.md