memorizz/mkdocs.yml at main · thesack490-svg/memorizz · 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
site_name: MemoRizz
site_description: Documentation for the MemoRizz memory framework for AI agents
site_url: https://richmondalake.github.io/memorizz
repo_name: RichmondAlake/memorizz
repo_url: https://github.com/RichmondAlake/memorizz
edit_uri: edit/main/docs/

nav:
  - Getting Started:
      - Overview: getting-started/overview.md
      - Concepts: getting-started/concepts.md
      - Python SDK Quickstart: getting-started/python-sdk-quickstart.md
  - Memory Types:
      - Semantic Memory: memory-types/semantic.md
      - Episodic Memory: memory-types/episodic.md
      - Procedural Memory: memory-types/procedural.md
      - Short-Term Memory: memory-types/short-term.md
      - Shared Memory: memory-types/shared.md
  - Memory Providers:
      - Oracle Provider: memory-providers/oracle.md
      - MongoDB Provider: memory-providers/mongodb.md
      - Filesystem Provider: memory-providers/filesystem.md
      - Bring Your Own Provider: memory-providers/custom.md
  - Use Cases:
      - Assistant Mode: use-cases/assistant-mode.md
      - Workflow Mode: use-cases/workflow-mode.md
      - Deep Research Mode: use-cases/deep-research-mode.md
  - Internet Access Providers: internet-access/providers.md
  - Utilities:
      - Context Window Stats: utilities/context_window_stats.md

theme:
  name: material
  language: en
  features:
    - navigation.instant
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - navigation.footer
    - toc.integrate
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
  palette:
    - scheme: default
      primary: deep purple
      accent: indigo
    - scheme: slate
      primary: deep purple
      accent: lime
  font:
    text: "Inter"
    code: "JetBrains Mono"

markdown_extensions:
  - admonition
  - footnotes
  - toc:
      permalink: true
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.snippets
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys

plugins:
  - search
  - git-revision-date-localized:
      fallback_to_build_date: true
      enable_creation_date: true
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_if_no_docstring: false
            filters: []
            heading_level: 2
            show_category_heading: true
            show_source: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/RichmondAlake/memorizz