vector-graph-rag/mkdocs.yml at main · zilliztech/vector-graph-rag · 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
site_name: Vector Graph RAG
site_url: https://zilliztech.github.io/vector-graph-rag/
site_description: A Graph RAG implementation using pure vector search with Milvus
repo_name: zilliztech/vector-graph-rag
repo_url: https://github.com/zilliztech/vector-graph-rag

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: teal
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: teal
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - navigation.instant
    - navigation.instant.progress
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - search.highlight
  logo: assets/logo.svg
  favicon: assets/logo.png
  icon:
    repo: fontawesome/brands/github

extra_css:
  - stylesheets/custom.css

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Guides:
    - Overview: guides/index.md
    - Document Import: guides/document-import.md
    - Incremental Updates: guides/incremental-updates.md
    - Observability: guides/observability.md
    - Embedding Providers: guides/embedding-providers.md
    - Multi-Tenancy: guides/multi-tenancy.md
    - Frontend Visualization: guides/frontend.md
  - Architecture:
    - How It Works: architecture/how-it-works.md
    - Design Philosophy: architecture/design-philosophy.md
  - API Reference:
    - Python API: reference/python-api.md
    - REST API: reference/rest-api.md
  - Evaluation: evaluation.md
  - Use Cases: use-cases.md
  - FAQ: faq.md

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