mirror of
https://github.com/microsoft/graphrag.git
synced 2026-01-06 12:11:01 +00:00
fc9895f793
* Replace docs by mkdocs-material * Fix markdown * Fix verions in gh-pages workflow * remove whitespaces * add semver * Add build docs check on python-ci * Fix command in index cli * Spellcheck * Spellcheck * remove docsite paths * clear outputs from notebook * remove dependabot npm for docsite * remove more docsite left overs * execute notebooks * Update notebooks * update poetry lock * Remove notebook build from ci * Revert dep update * Navigation tabs * Fix stylesheet * add kwds to dictionary * Turn on notebook execution * Update gitignore * Add MSR Blog posts * spellcheck * Accessibility Changes --------- Co-authored-by: Alonso Guevara <alonsog@microsoft.com>
107 lines
3.3 KiB
YAML
107 lines
3.3 KiB
YAML
site_name: GraphRAG
|
|
|
|
theme:
|
|
name: material
|
|
icon:
|
|
logo: octicons/ai-model-24
|
|
palette:
|
|
- scheme: default
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
|
|
- scheme: slate
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Switch to light mode
|
|
features:
|
|
- content.code.copy
|
|
- content.code.select
|
|
- navigation.footer
|
|
- navigation.tabs
|
|
|
|
nav:
|
|
- Home:
|
|
- Welcome: index.md
|
|
- Getting Started: get_started.md
|
|
- Development Guide: developing.md
|
|
- Indexing:
|
|
- Overview: "index/overview.md"
|
|
- Architecture: "index/architecture.md"
|
|
- Dataflow: "index/default_dataflow.md"
|
|
- CLI: "index/cli.md"
|
|
- Configuration:
|
|
- Overview: "config/overview.md"
|
|
- Init Command: "config/init.md"
|
|
- Using Env Vars: "config/env_vars.md"
|
|
- Using JSON or YAML: "config/json_yaml.md"
|
|
- Fully Custom: "config/custom.md"
|
|
- Template: "config/template.md"
|
|
- Prompt Tuning:
|
|
- Overview: "prompt_tuning/overview.md"
|
|
- Auto Tuning: "prompt_tuning/auto_prompt_tuning.md"
|
|
- Manual Tuning: "prompt_tuning/manual_prompt_tuning.md"
|
|
- Query:
|
|
- Overview: "query/overview.md"
|
|
- Local Search: "query/local_search.md"
|
|
- Question Generation: "query/question_generation.md"
|
|
- Global Search: "query/global_search.md"
|
|
- CLI: "query/cli.md"
|
|
- Notebooks:
|
|
- Overview: "query/notebooks/overview.md"
|
|
- Global Search: "examples_notebooks/global_search.ipynb"
|
|
- Local Search: "examples_notebooks/local_search.ipynb"
|
|
- Microsoft Research Blog: "blog_posts.md"
|
|
- Extras:
|
|
- Operation Dulce:
|
|
- About: "data/operation_dulce/ABOUT.md"
|
|
- Document: "data/operation_dulce/Operation Dulce v2 1 1.md"
|
|
plugins:
|
|
- search
|
|
- exclude-search:
|
|
exclude:
|
|
- "data/operation_dulce/Operation Dulce v2 1 1.md"
|
|
exclude_unreferenced: true
|
|
- mkdocs-jupyter:
|
|
execute: true
|
|
|
|
repo_url: https://github.com/microsoft/graphrag
|
|
repo_name: graphrag
|
|
copyright: >
|
|
© 2025 Microsoft |
|
|
<a href="https://go.microsoft.com/fwlink/?LinkId=521839">Privacy</a> |
|
|
<a href="https://go.microsoft.com/fwlink/?LinkId=2259814">Consumer Heath Privacy</a> |
|
|
<a onclick="window.manageConsent();">Cookies</a> |
|
|
<a href="https://go.microsoft.com/fwlink/?LinkID=206977">Terms of Use</a> |
|
|
<a href="https://www.microsoft.com/trademarks">Trademarks</a>
|
|
|
|
extra:
|
|
polyfills:
|
|
- "https://wcpstatic.microsoft.com/mscc/lib/v2/wcp-consent.js"
|
|
|
|
extra_css:
|
|
- stylesheets/extra.css
|
|
|
|
extra_javascript:
|
|
- "scripts/create_cookie_banner.js"
|
|
|
|
markdown_extensions:
|
|
- pymdownx.highlight:
|
|
anchor_linenums: true
|
|
- pymdownx.superfences:
|
|
custom_fences:
|
|
- name: mermaid
|
|
class: mermaid
|
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
|
- attr_list
|
|
- md_in_html
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:material.extensions.emoji.twemoji
|
|
emoji_generator: !!python/name:material.extensions.emoji.to_svg
|
|
- pymdownx.tabbed:
|
|
alternate_style: true
|
|
combine_header_slug: true
|
|
slugify: !!python/object/apply:pymdownx.slugs.slugify
|
|
kwds:
|
|
case: lower
|