mkdocs.yml

site_name: Magentic
site_description: Seamlessly integrate LLMs as Python functions
strict: true
site_url: https://magentic.dev/

repo_name: jackmpcollins/magentic
repo_url: https://github.com/jackmpcollins/magentic
edit_uri: blob/main/docs/

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme)"
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: purple
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: purple
      accent: yellow
  features:
    - content.action.edit
    - content.code.copy
    - content.code.select
    - content.tooltips
    - navigation.expand
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - search.suggest

plugins:
  - glightbox
  - mkdocs-jupyter:
      # ignore_h1_titles: true
      execute: false
  - search

markdown_extensions:
  - tables
  - toc:
      permalink: true
      title: Page contents
  - admonition
  - pymdownx.details
  - pymdownx.highlight:
      pygments_lang_class: true
  - pymdownx.extra

extra_css:
  - css/jupyter-notebook.css

extra:
  analytics:
    provider: google
    property: G-CWJ8LL02SG
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: octicons/thumbsdown-16
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback!
        - icon: octicons/thumbsup-16
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
  social:
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/jackmpcollins
    - icon: fontawesome/brands/github
      link: https://github.com/jackmpcollins

# https://www.mkdocs.org/user-guide/configuration/#validation
validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

nav:
  - Overview: index.md
  - structured-outputs.md
  - chat-prompting.md
  - chat.md
  - function-calling.md
  - formatting.md
  - asyncio.md
  - streaming.md
  - vision.md
  - retrying.md
  - logging-and-tracing.md
  - configuration.md
  - type-checking.md
  - Examples:
      - examples/rag_github.ipynb
      - examples/vision_renaming_screenshots.ipynb
      - examples/registering_custom_type.ipynb
      - examples/chain_of_verification.ipynb