MiQi/mkdocs.yml at main · lichman0405/MiQi · 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
site_name: MiQi Desktop
site_description: 基于 Electron 的轻量级个人 AI 助手桌面应用 — 完整技术文档
# site_url: https://14790897.github.io/miqi/
repo_url: https://github.com/14790897/miqi
repo_name: 14790897/miqi
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      accent: deep purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: deep purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.indexes
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
  icon:
    repo: fontawesome/brands/github

extra_javascript:
  - https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.min.js

plugins:
  - search

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_div_format
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path: ["."]
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - toc:
      permalink: true
  - attr_list
  - md_in_html

nav:
  - 首页: index.md
  - 快速开始: getting-started.md
  - 系统架构:
      - 整体架构: architecture.md
      - 数据流: architecture/data-flow.md
      - 项目结构: architecture/project-structure.md
  - Python 后端:
      - Agent 引擎: backend/agent.md
      - 工具系统: backend/tools.md
      - Provider 系统: backend/providers.md
      - 记忆系统: backend/memory.md
      - 会话管理: backend/session.md
      - 任务追踪: backend/trace.md
      - Bridge 通信: backend/bridge.md
  - Electron 前端:
      - 前端概览: frontend/overview.md
      - IPC 通信: frontend/ipc.md
      - 功能页面: frontend/features.md
      - SkillHub: frontend/skillhub.md
  - MCP 集成: mcp-integration.md
  - 配置与部署:
      - 配置参考: configuration.md
      - Docker 部署: deployment/docker.md
      - 桌面打包: deployment/packaging.md
  - 开发指南:
      - 开发环境搭建: developer-guide.md
      - 贡献指南: contributing.md
  - 更新日志: changelog.md