code-graph-rag/mkdocs.yml at main · vitali87/code-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
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
109
110
111
112
113
114
115
116
site_name: Code-Graph-RAG
site_url: https://docs.code-graph-rag.com
site_description: >-
  Graph-based RAG system that parses multi-language codebases with Tree-sitter,
  builds knowledge graphs, and enables natural language querying, editing,
  and optimization.
site_author: Vitali Avagyan

repo_name: vitali87/code-graph-rag
repo_url: https://github.com/vitali87/code-graph-rag
edit_uri: edit/main/docs/

copyright: Copyright &copy; 2024 Vitali Avagyan

theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/logo-icon.png
  favicon: assets/favicon.png
  font:
    text: Inter
    code: JetBrains Mono
  palette:
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - toc.follow
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - minify:
      minify_html: true

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

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Configuration: getting-started/configuration.md
    - Quick Start: getting-started/quickstart.md
  - User Guide:
    - CLI Reference: guide/cli-reference.md
    - Interactive Querying: guide/interactive-querying.md
    - Code Optimization: guide/code-optimization.md
    - Graph Export: guide/graph-export.md
    - Real-Time Updates: guide/realtime-updates.md
    - MCP Server: guide/mcp-server.md
  - Python SDK:
    - Overview: sdk/overview.md
    - Graph Loader: sdk/graph-loader.md
    - Cypher Generator: sdk/cypher-generator.md
    - Semantic Search: sdk/semantic-search.md
  - Architecture:
    - Overview: architecture/overview.md
    - Graph Schema: architecture/graph-schema.md
    - Language Support: architecture/language-support.md
  - Advanced:
    - Adding Languages: advanced/adding-languages.md
    - Ignore Patterns: advanced/ignore-patterns.md
    - Building Binaries: advanced/building-binaries.md
    - Troubleshooting: advanced/troubleshooting.md
  - Contributing: contributing.md

extra_css:
  - stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/vitali87/code-graph-rag
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/code-graph-rag/
  generator: false