mkdocs.yml

site_name: django-swap-user documentation

nav:
    - 🃏 django-swap-user:
        - 🃏 django-swap-user: index.md
        - 🔧 swap models: swap_models.md
        - 🧨 one time passwords : otp_models.md
        - ⚙️ settings: settings.md
    - 📖 Code API:
      - swap_user.otp.services: code_api/otp_services.md
      - swap_user.otp.senders: code_api/otp_senders.md
      - swap_user.otp.forms: code_api/otp_forms.md
      - swap_user.otp.views: code_api/otp_views.md


repo_name: artinnok/django-swap-user
repo_url: https://github.com/artinnok/django-swap-user




theme:
  logo: media/images/django-swap-user-logo.svg
  name: material
  language: en
    # Palette toggle for light mode
  palette:

    - media: "(prefers-color-scheme: light)"
      scheme: special
      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
        primary: deep orange
  features:
    - content.code.annotate
    # - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.expand
    - navigation.indexes
    # - navigation.instant
    # - navigation.prune
    - navigation.sections
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - toc.integrate

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - meta
  - attr_list
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:materialx.emoji.to_svg
      emoji_index: !!python/name:materialx.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - 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/artinnok/django-swap-user
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/django-swap-user/


extra_css:
  - stylesheets/extra.css
  - stylesheets/termynal.css
  - stylesheets/custom.css


extra_javascript:
  - javascript/termynal.js
  - javascript/custom.js


edit_uri: ""

plugins:
    - mkdocs-video
    - mkdocstrings