site_name: NeuralMemory
site_description: Reflex-based memory system for AI agents - retrieval through activation, not search
site_url: https://nhadaututtheky.github.io/neural-memory
repo_url: https://github.com/nhadaututtheky/neural-memory
repo_name: nhadaututtheky/neural-memory
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.footer
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
  icon:
    repo: fontawesome/brands/github
  logo: assets/logo.svg
  favicon: assets/favicon.png

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true
            show_root_heading: true
            heading_level: 2

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

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
    - CLI Reference: getting-started/cli.md
  - Concepts:
    - How It Works: concepts/how-it-works.md
    - Neurons & Synapses: concepts/neurons-synapses.md
    - Memory Types: concepts/memory-types.md
    - Spreading Activation: concepts/spreading-activation.md
  - Guides:
    - Integration: guides/integration.md
    - MCP Server: guides/mcp-server.md
    - Embedding Setup: guides/embedding-setup.md
    - Brain Sharing: guides/brain-sharing.md
    - Multi-Brain Setup: guides/multi-brain-setup.md
    - Brain Health Guide: guides/brain-health.md
    - OpenClaw Plugin: guides/openclaw-plugin.md
    - Safety & Security: guides/safety.md
  - API Reference:
    - Python API: api/python.md
    - Server API: api/server.md
  - Architecture:
    - Overview: architecture/overview.md
    - Scalability: architecture/scalability.md
  - Benchmarks: benchmarks.md
  - FAQ: FAQ.md
  - Contributing: contributing.md
  - Changelog: changelog.md
  - Blog:
    - Why I Built NeuralMemory: blog/why-i-built-neuralmemory.md
    - Honest Comparison 2026: blog/honest-comparison-2026.md
    - OpenClaw Integration: blog/neural-memory-openclaw.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/nhadaututtheky/neural-memory
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/neural-memory/
  version:
    provider: mike

copyright: Copyright &copy; 2024-2026 NeuralMemory Contributors
