MIRIX-docs/mkdocs.yml at main · Mirix-AI/MIRIX-docs · 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
99
100
101
102
103
104
105
106
107
108
site_name: MIRIX Documentation
site_description: Multi-agent personal assistant for intelligent screen activity tracking
site_author: MIRIX Team
site_url: https://mirix-ai.github.io/MIRIX-docs/

repo_name: Mirix-AI/MIRIX
repo_url: https://github.com/Mirix-AI/MIRIX
edit_uri: edit/main/docs/

theme:
  name: material
  logo: assets/images/logo.png
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: indigo
      accent: cyan
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      primary: indigo
      accent: cyan
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - search.highlight
    - search.share
    - toc.follow
    - content.code.copy
    - content.code.annotate

plugins:
  - search
  - mkdocstrings

exclude_docs: |
  assets/README.md

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
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
  - Home: index.md
  - Get Started:
    - Overview: getting-started/overview.md
    - Quickstart: getting-started/quickstart.md
  - Memory Write:
    - Configuration: memory-write/configuration.md
  - Memory Search:
    - Search: memory-search/search.md
  - Architecture:
    - Multi-Agent System: architecture/multi-agent-system.md
    - Memory Components: architecture/memory-components.md
    - Search Capabilities: architecture/search-capabilities.md
  - Legacy:
    - Overview: legacy/index.md
    - Getting Started:
      - Installation (Desktop): legacy/getting-started/installation.md
    - User Guide:
      - Desktop App: legacy/user-guide/desktop-app.md
      - Multi-User Support: legacy/user-guide/multi-user.md
      - Backend Usage: legacy/user-guide/backend-usage.md
      - Custom Models: legacy/user-guide/custom-models.md
      - Custom Tools: legacy/user-guide/custom-tools.md
    - Advanced:
      - Performance: legacy/advanced/performance.md
      - Security & Privacy: legacy/advanced/security-privacy.md
      - Backup & Restore: legacy/advanced/backup-restore.md
  - Contributing: contributing.md

extra_css:
  - assets/custom.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Mirix-AI/MIRIX
    - icon: fontawesome/solid/envelope
      link: mailto:yuw164@ucsd.edu

copyright: Copyright &copy; 2025 MIRIX Team