memsearch/mkdocs.yml at main · zilliztech/memsearch · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
site_name: memsearch
site_description: "Cross-platform semantic memory for AI coding agents — markdown-first, backed by Milvus"
site_url: https://zilliztech.github.io/memsearch/

theme:
  name: material
  palette:
    scheme: slate
    primary: black
    accent: deep orange
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - search.highlight
    - content.code.copy
  font:
    text: Fira Code
    code: Fira Code
  logo: assets/logo-icon.jpg
  favicon: assets/logo-icon.jpg
  icon:
    repo: fontawesome/brands/github

extra_css:
  - stylesheets/terminal.css

repo_url: https://github.com/zilliztech/memsearch
repo_name: zilliztech/memsearch

nav:
  - Home:
    - Overview: index.md
    - Why memsearch: home/why.md
    - For Agent Users: home/for-users.md
    - For Agent Developers: home/for-developers.md
    - Configuration: home/configuration.md
    - Skills from Memory: home/skills-from-memory.md
    - Architecture: architecture.md
    - Design Philosophy: design-philosophy.md
    - Comparison with Alternatives: home/comparison.md
    - Embedding Model Evaluation: home/embedding-evaluation.md
    - Reranking Evaluation: https://github.com/zilliztech/memsearch/blob/main/evaluation/reranking-evaluation.md
    - Quickstart: getting-started.md
    - FAQ: faq.md
    - Troubleshooting: troubleshooting.md
  - Claude Code Plugin:
    - Overview: platforms/claude-code/index.md
    - Installation: platforms/claude-code/installation.md
    - How It Works: platforms/claude-code/how-it-works.md
    - Memory Recall: platforms/claude-code/memory-recall.md
    - Troubleshooting: platforms/claude-code/troubleshooting.md
  - Codex Plugin:
    - Overview: platforms/codex/index.md
    - Installation: platforms/codex/installation.md
    - How It Works: platforms/codex/how-it-works.md
    - Memory Recall: platforms/codex/memory-recall.md
  - DeepSeek Harness Plugin:
    - Overview: platforms/dsh/index.md
    - Installation: platforms/dsh/installation.md
    - How It Works: platforms/dsh/how-it-works.md
  - OpenClaw Plugin:
    - Overview: platforms/openclaw/index.md
    - Installation: platforms/openclaw/installation.md
    - How It Works: platforms/openclaw/how-it-works.md
    - Memory Tools: platforms/openclaw/memory-tools.md
  - OpenCode Plugin:
    - Overview: platforms/opencode/index.md
    - Installation: platforms/opencode/installation.md
    - How It Works: platforms/opencode/how-it-works.md
    - Memory Tools: platforms/opencode/memory-tools.md
  - For Agent Developers:
    - CLI Reference: cli.md
    - Python API: python-api.md
    - Integrations: integrations.md
  - Platform Comparison: platforms/index.md

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