Skip to content

Commit 31eba28

Browse files
CheShipingCheShiping
committed
"add-vitepress-docs"
1 parent 31ecf3b commit 31eba28

28 files changed

Lines changed: 2808 additions & 2 deletions

‎.github/workflows/deploy-docs.yml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: Deploy Docs to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [master]
6+
paths:
7+
- 'docs/**'
8+
9+
workflow_dispatch:
10+
11+
permissions:
12+
contents: read
13+
pages: write
14+
id-token: write
15+
16+
concurrency:
17+
group: pages
18+
cancel-in-progress: false
19+
20+
jobs:
21+
build:
22+
runs-on: ubuntu-latest
23+
steps:
24+
- name: Checkout
25+
uses: actions/checkout@v4
26+
27+
- name: Setup Node
28+
uses: actions/setup-node@v4
29+
with:
30+
node-version: 20
31+
32+
- name: Setup Pages
33+
uses: actions/configure-pages@v4
34+
35+
- name: Install dependencies
36+
run: npm ci
37+
working-directory: docs
38+
39+
- name: Build with VitePress
40+
run: npm run build
41+
working-directory: docs
42+
43+
- name: Upload artifact
44+
uses: actions/upload-pages-artifact@v3
45+
with:
46+
path: docs/.vitepress/dist
47+
48+
deploy:
49+
environment:
50+
name: github-pages
51+
url: ${{ steps.deployment.outputs.page_url }}
52+
runs-on: ubuntu-latest
53+
needs: build
54+
steps:
55+
- name: Deploy to GitHub Pages
56+
id: deployment
57+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ env/
2121
# Node
2222
node_modules/
2323

24+
# VitePress
25+
docs/.vitepress/dist/
26+
docs/.vitepress/cache/
27+
2428
# Environment
2529
.env
2630
.env.local

‎docs/.vitepress/config.mts‎

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
import { defineConfig } from 'vitepress'
2+
3+
export default defineConfig({
4+
title: 'Deep Research',
5+
description: '多智能体深度研究平台 — 企业级技术教程',
6+
lang: 'zh-CN',
7+
8+
head: [
9+
['link', { rel: 'icon', href: '/favicon.ico' }],
10+
],
11+
12+
themeConfig: {
13+
logo: { light: '/logo.svg', dark: '/logo.svg' },
14+
15+
nav: [
16+
{ text: '首页', link: '/' },
17+
{ text: '教程', link: '/deep-research/01-项目概述与架构设计' },
18+
{
19+
text: '项目源码',
20+
items: [
21+
{ text: 'deep_research 核心', link: 'https://github.com/CheShiping/deep_research/tree/master/deep_research' },
22+
{ text: 'scaffold 脚手架', link: 'https://github.com/CheShiping/deep_research/tree/master/deep_research_scaffold' },
23+
{ text: 'cloud_agent 云客服', link: 'https://github.com/CheShiping/deep_research/tree/master/cloud_agent' },
24+
]
25+
},
26+
],
27+
28+
sidebar: {
29+
'/deep-research/': [
30+
{
31+
text: 'Part 1 — 多智能体深度研究平台',
32+
items: [
33+
{ text: '1. 项目概述与架构设计', link: '/deep-research/01-项目概述与架构设计' },
34+
{ text: '2. 环境搭建与依赖管理', link: '/deep-research/02-环境搭建与依赖管理' },
35+
{ text: '3. 多智能体工作流引擎', link: '/deep-research/03-多智能体工作流引擎' },
36+
{ text: '4. 记忆系统设计与实现', link: '/deep-research/04-记忆系统设计与实现' },
37+
{ text: '5. RAG 检索增强生成', link: '/deep-research/05-RAG检索增强生成' },
38+
{ text: '6. FastAPI 后端服务', link: '/deep-research/06-FastAPI后端服务' },
39+
{ text: '7. Vue 3 前端开发', link: '/deep-research/07-Vue3前端开发' },
40+
{ text: '8. 部署与运维指南', link: '/deep-research/08-部署与运维指南' },
41+
{ text: '9. 最佳实践与常见问题', link: '/deep-research/09-最佳实践与常见问题' },
42+
]
43+
}
44+
],
45+
'/scaffold/': [
46+
{
47+
text: 'Part 2 — 可复用脚手架模板',
48+
items: [
49+
{ text: '1. 脚手架概述与设计哲学', link: '/scaffold/01-脚手架概述与设计哲学' },
50+
{ text: '2. 核心架构与扩展点', link: '/scaffold/02-核心架构与扩展点' },
51+
{ text: '3. 从脚手架到生产级项目', link: '/scaffold/03-从脚手架到生产级项目' },
52+
{ text: '4. 自定义 LLM 适配器', link: '/scaffold/04-自定义LLM适配器' },
53+
]
54+
}
55+
],
56+
'/cloud-agent/': [
57+
{
58+
text: 'Part 3 — 云平台智能客服系统',
59+
items: [
60+
{ text: '1. 项目概述与系统架构', link: '/cloud-agent/01-项目概述与系统架构' },
61+
{ text: '2. 多智能体路由与编排', link: '/cloud-agent/02-多智能体路由与编排' },
62+
{ text: '3. 知识图谱与 RAG 系统', link: '/cloud-agent/03-知识图谱与RAG系统' },
63+
{ text: '4. MCP 工具服务器', link: '/cloud-agent/04-MCP工具服务器' },
64+
{ text: '5. 记忆与语义缓存', link: '/cloud-agent/05-记忆与语义缓存' },
65+
{ text: '6. FastAPI 后端与前端', link: '/cloud-agent/06-FastAPI后端与前端' },
66+
{ text: '7. 部署与运维', link: '/cloud-agent/07-部署与运维' },
67+
]
68+
}
69+
],
70+
'/appendix/': [
71+
{
72+
text: '附录',
73+
items: [
74+
{ text: '术语表', link: '/appendix/glossary' },
75+
{ text: '配置参考', link: '/appendix/configuration-reference' },
76+
]
77+
}
78+
],
79+
},
80+
81+
socialLinks: [
82+
{ icon: 'github', link: 'https://github.com/CheShiping/deep_research' }
83+
],
84+
85+
footer: {
86+
message: '基于 LangGraph · FastAPI · Vue 3 · Milvus · Neo4j 构建',
87+
copyright: 'Copyright © 2026 Deep Research'
88+
},
89+
90+
search: {
91+
provider: 'local',
92+
options: {
93+
translations: {
94+
button: { buttonText: '搜索文档' },
95+
modal: {
96+
noResultsText: '无结果',
97+
footer: { closeText: '关闭' }
98+
}
99+
}
100+
}
101+
},
102+
103+
docFooter: {
104+
prev: '上一章',
105+
next: '下一章'
106+
},
107+
108+
outline: {
109+
label: '本页目录',
110+
level: [2, 3]
111+
},
112+
113+
editLink: {
114+
pattern: 'https://github.com/CheShiping/deep_research/edit/master/docs/:path',
115+
text: '在 GitHub 上编辑此页'
116+
},
117+
118+
lastUpdated: {
119+
text: '最后更新',
120+
formatOptions: { dateStyle: 'short' }
121+
}
122+
},
123+
124+
markdown: {
125+
lineNumbers: true,
126+
}
127+
})

deep_research-tutorial/appendix/configuration-reference.md renamed to docs/appendix/configuration-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -290,4 +290,4 @@ curl http://localhost:5000/api/chat -X POST -H "Content-Type: application/json"
290290

291291
---
292292

293-
> 📖 **返回**：[教程首页](../README.md) | [术语表](./glossary.md)
293+
> 📖 **返回**：[教程首页](/) | [术语表](./glossary.md)

deep_research-tutorial/appendix/glossary.md renamed to docs/appendix/glossary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,4 +181,4 @@ Python 类型注解工具，定义字典的键和值类型。LangGraph 的状态
181181

182182
---
183183

184-
> 📖 **返回**：[教程首页](../README.md) | [配置参考](./configuration-reference.md)
184+
> 📖 **返回**：[教程首页](/) | [配置参考](./configuration-reference.md)

deep_research-tutorial/part3-cloud-agent/01-项目概述与系统架构.md renamed to docs/cloud-agent/01-项目概述与系统架构.md

File renamed without changes.

deep_research-tutorial/part3-cloud-agent/02-多智能体路由与编排.md renamed to docs/cloud-agent/02-多智能体路由与编排.md

File renamed without changes.

deep_research-tutorial/part3-cloud-agent/03-知识图谱与RAG系统.md renamed to docs/cloud-agent/03-知识图谱与RAG系统.md

File renamed without changes.

deep_research-tutorial/part3-cloud-agent/04-MCP工具服务器.md renamed to docs/cloud-agent/04-MCP工具服务器.md

File renamed without changes.

deep_research-tutorial/part3-cloud-agent/05-记忆与语义缓存.md renamed to docs/cloud-agent/05-记忆与语义缓存.md

File renamed without changes.

0 commit comments

Comments
 (0)