mkdocs.yml

site_name: The Cheshire Cat API Python Client
repo_url: https://github.com/cheshire-cat-ai/api-client-py

docs_dir: mkdocs
site_dir: api-client-py

plugins:
  - mkdocs-video:
      is_video: True
      video_muted: True
      video_autoplay: False
      video_type: mp4
  - search
  - gen-files:
      scripts:
        - gen_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - section-index
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            docstring_style: sphinx

#hooks:
#  - mkdocs/hooks/drawio_file.py

nav:
  - Getting started:
      - Installation: getting_started/installation.md
      - Usage: getting_started/examples.md
  - API Documentation: API_Documentation/

theme:
  name: material
  favicon: assets/favicon.ico
  logo: assets/cheshire-cat-logo.svg
  palette:
    # Palette toggle for light mode
    - scheme: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      primary: black
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    #text: Old Standard TT
    text: Source Serif Pro
  features:
    - navigation.indexes
    - navigation.footer
    - navigation.top
#    - navigation.tabs
#    - navigation.tabs.sticky
    - navigation.sections
    - content.code.copy
    - content.code.annotate
    - search.suggest
    - search.highlight

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/cheshire-cat-ai/core
      name: The Cheshire Cat repository on GitHub
    - icon: fontawesome/brands/discord
      link: https://discord.gg/bHX5sNFCYU
      name: The Cheshire Cat Discord Server

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - footnotes
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format