mkdocs.yml

site_name: PLUTUS Pair-Trading Toolkit
theme: 
  features:
    - navigation.footer
    - search.suggest
    - content.footnote.tooltips
    - content.code.copy
    - content.code.select
    - content.code.annotate

  name: material
  logo: assets/favicon.png
  favicon: assets/favicon.png
  palette:
    # Light Mode
    - scheme: default
      toggle:
        icon: material/brightness-4
        name: Light mode
      primary: blue grey
      accent: indigo
    
    # Dark Mode
    - scheme: slate
      toggle:
        icon: material/brightness-7
        name: Dark mode
      primary: orange
      accent: deep orange

nav:
  - Home: index.md
  - Installation: installation.md
  - Demo: demo.md
  - Support: SUPPORT.md
  - Contributing: CONTRIBUTING.md
  - Code of Conduct: CODE_OF_CONDUCT.md
  - Security Policies: SECURITY.md
  - License: LICENSE.md

extra:
  social:
    - icon: fontawesome/solid/envelope
      link: mailto:contact@fox-techniques.com?subject=Inquiry%20about%20PLUTUSt%20Pair-Tradingt%20Toolkit
    - icon: fontawesome/brands/github
      link: https://github.com/fox-techniques/plutus-pairtrading
    - icon: fontawesome/brands/discord
      link: https://discord.gg/fPg7vbnCTR
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/foxtechniques/
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/fox-techniques/

copyright: Copyright © 2025 FOX Techniques

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