mkdocs.yml

site_name: FastMLX
site_description: FastMLX is a high performance production ready API to host MLX models.
site_author: Blaizzy
repo_name: Blaizzy/fastmlx
site_url: https://Blaizzy.github.io/fastmlx
repo_url: https://github.com/Blaizzy/fastmlx

copyright: "Copyright © 2024 - 2024 Prince Canuma"

theme:
    palette:
        - scheme: default
          primary: black
          toggle:
              icon: material/toggle-switch-off-outline
              name: Switch to dark mode
        - scheme: slate
          primary: black
          accent: indigo
          toggle:
              icon: material/toggle-switch
              name: Switch to light mode
    name: material
    icon:
        repo: fontawesome/brands/github
    # logo: assets/logo.png
    # favicon: assets/favicon.png
    features:
        - navigation.instant
        - navigation.tracking
        - navigation.top
        - navigation.footer  # Adds a "Next" and "Previous" navigation to the footer
        - search.highlight
        - search.share
        - content.code.copy  # Adds a copy button to code blocks
       
    custom_dir: "docs/overrides"
    font:
        text: Google Sans
        code: Regular

plugins:
    - search
    - mkdocstrings
    # - pdf-export
    - mkdocs-jupyter:
          include_source: True
          ignore_h1_titles: True
          execute: True
          allow_errors: false
          ignore: ["conf.py"]
          execute_ignore: ["*ignore.ipynb"]

markdown_extensions:
    - admonition
    - abbr
    - attr_list
    - def_list
    - footnotes
    - meta
    - md_in_html
    - pymdownx.superfences
    - pymdownx.highlight:
          linenums: true
    - toc:
          permalink: true

extra:
    social:
        - icon: fontawesome/brands/github
          link: https://github.com/Blaizzy
        - icon: fontawesome/brands/twitter
          link: https://twitter.com/Prince_Canuma
    version:
        provider: mike  # Uncomment if you decide to use mike for versioning
    consent:
        title: Cookie consent
        description: >-
          We use cookies to recognize your repeated visits and preferences, as well
          as to measure the effectiveness of our documentation and whether users
          find what they're searching for. With your consent, you're helping us to
          make our documentation better.

extra_css:
    - stylesheets/extra.css

# extra:
#     analytics:
#         provider: google
#         property: UA-XXXXXXXXX-X

nav:
    - Home: index.md
    - Installation: installation.md
    - Usage: usage.md
    - CLI Reference: cli_reference.md
    - Examples:
        - Multi-Modal Chatbot: examples/chatbot.md
        - Function Calling: examples/function_calling.md

    - Managing Models: models.md
    - API Reference: endpoints.md
    - Contributing: contributing.md
    - Community Projects: community_projects.md
    - Report Issues: https://github.com/Blaizzy/fastmlx/issues
    - Changelog: changelog.md