mkdocs.yml

site_name: Zep - The Memory Foundation For Your AI Stack
site_url: https://docs.getzep.com
site_description: Build AI assistants that continually learn and delight users with personalized and accurate experiences.
copyright: Copyright © 2024 - Zep Software, Inc.
repo_url: https://github.com/getzep/zep
edit_uri: https://github.com/getzep/docs.getzep.com/blob/main/docs/
extra_css:
  - stylesheets/extra.css
extra:
  analytics:
    provider: posthog
  homepage: https://www.getzep.com
nav:
  - Home: index.md
  - Quick Start ⚡️: deployment/quickstart.md
  - SDKs and API:
      - Installation: 
          - sdk/index.md
      - Document Store: 
          - sdk/documents.md
      - Chat History:
          - Overview: sdk/chat_history/index.md
          - Users: sdk/chat_history/users.md
          - Sessions: sdk/chat_history/sessions.md
          - Messages: sdk/chat_history/messages.md
          - Memories: sdk/chat_history/memories.md
          - Search Chat History: sdk/chat_history/search.md
      - Zep Search: 
          - sdk/search_query.md
      - Enrichments: 
          - sdk/extractors.md
      - Frameworks:
          - LangChain 🦜⛓️: sdk/langchain.md
          - LlamaIndex 🦙: sdk/llamaindex.md
      - Examples:
          - sdk/examples.md
      - APIs:
          - Python SDK API: https://getzep.github.io/zep-python/
          - JavaScript SDK API: https://getzep.github.io/zep-js/
          - REST API: https://getzep.github.io/zep/
  - Deployment:
      - deployment/index.md
      - Quick Start: deployment/quickstart.md
      - Web UI: deployment/webui.md
      - Securing Zep: deployment/security.md
      - Production: deployment/production.md
      - Render: deployment/render.md
      - Kubernetes: deployment/kubernetes.md
  - Configuration:
      - deployment/config.md
      - Selecting Embedding Models: deployment/embeddings.md
      - Authentication: deployment/auth.md
      - LLM API Config: deployment/llm_config.md
      - Custom Prompts: deployment/prompts.md
      - OpenTelemetry: deployment/otel.md
      - Data Management: deployment/data.md

  - Support: support/index.md
theme:
  name: material
  custom_dir: overrides
  favicon: images/favicon.png
  features:
    - content.action.edit
    - navigation.tracking
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.indexes
    - navigation.footer
    - toc.follow
    - navigation.top
    - search
    - search.suggest
    - content.tabs.link
    - content.code.copy
    - content.code.annotate
    - announce.dismiss
    - navigation.path
    - navigation.instant
    - navigation.instant.prefetch
  logo: images/zep-bot-square-50x50.png
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: deep purple
      toggle:
        icon: material/weather-night
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      primary: deep purple
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - attr_list
  - md_in_html
  - admonition
  - codehilite
  - abbr
  - def_list
  - tables
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - typeset
  - optimize
  - git-revision-date-localized:
      enable_creation_date: true