docs: 更新文档结构

This commit is contained in:
Wenjie Zhang 2025-10-10 01:26:12 +08:00
parent 8c39d7e6e0
commit 2671b60dff
15 changed files with 53 additions and 73 deletions

View File

@ -14,8 +14,8 @@ export default defineConfig({
},
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
logo: "/favicon.svg",
nav: [
{ text: 'Home', link: '/' },
{ text: '简介', link: '/intro/quick-start' },
{ text: '更新日志', link: '/changelog/update' }
],
@ -37,6 +37,36 @@ export default defineConfig({
socialLinks: [
{ icon: 'github', link: 'https://github.com/xerrors/Yuxi-Know' }
]
],
footer: {
message: '本项目基于 MIT License 开源,欢迎使用和贡献。',
copyright: 'Copyright © 2025-present Yuxi'
},
editLink: {
pattern: 'https://github.com/xerrors/Yuxi-Know/edit/main/docs/:path',
text: '在 GitHub 上编辑此页'
},
lastUpdated: {
text: '最后更新时间',
formatOptions: {
dateStyle: 'full',
timeStyle: 'medium'
}
},
search: {
provider: 'local'
},
docFooter: {
prev: '上一页',
next: '下一页'
}
},
})

Binary file not shown.

Before

Width:  |  Height:  |  Size: 184 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 304 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 613 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 228 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.4 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 80 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 891 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 379 KiB

View File

@ -6,6 +6,9 @@ hero:
name: "Yuxi-Know"
text: "智能知识库与知识图谱问答系统"
tagline: 基于 LangGraph + Vue.js + FastAPI + LightRAG 架构构建的智能问答平台
image:
src: /bb.png
alt: VitePress
actions:
- theme: brand
text: 快速开始
@ -29,3 +32,10 @@ features:
details: 完整的测试套件、API 文档、监控日志,适合企业级部署和使用
---
## 轻松部署
```sh
docker compose up --build -d
```

View File

@ -293,6 +293,7 @@ vllm serve BAAI/bge-reranker-v2-m3 \
<tr>
<td><img src="https://github.com/user-attachments/assets/6ad3cc6a-3816-4545-b074-6eeb814d8124" alt="知识图谱可视化"></td>
<td><img src="https://github.com/user-attachments/assets/6cc3c3a6-b7c2-4dc3-9678-b97de7835959" alt="知识库可视化"></td>
<td><img src="/images/neo4j_browser.png"></td>
</tr>
</tbody>
</table>
@ -764,23 +765,3 @@ docker restart api-dev
- 添加必要的测试用例
- 更新相关文档
- 确保所有测试通过
## 项目信息
### Star History
[![Star History Chart](https://api.star-history.com/svg?repos=xerrors/Yuxi-Know)](https://star-history.com/#xerrors/Yuxi-Know)
### 许可证
本项目采用 MIT 许可证 - 查看 [LICENSE](LICENSE) 文件了解详情。
---
<div align="center">
**如果这个项目对您有帮助,请不要忘记给我们一个 ⭐️**
[报告问题](https://github.com/xerrors/Yuxi-Know/issues) | [功能请求](https://github.com/xerrors/Yuxi-Know/issues) | [讨论](https://github.com/xerrors/Yuxi-Know/discussions)
</div>

BIN
docs/public/bb.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.7 MiB

10
docs/public/favicon.svg Normal file
View File

@ -0,0 +1,10 @@
<svg width="128" height="128" style="enable-background:new 0 0 128 128;" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<path d="M63.79,8.64C1.48,8.64,0,78.5,0,92.33c0,13.83,28.56,25.03,63.79,25.03 c35.24,0,63.79-11.21,63.79-25.03C127.58,78.5,126.11,8.64,63.79,8.64z" style="fill:#FCC21B;"/>
<path d="M63.91,104.82c-3.43,0-6.87-0.43-10.25-1.31c-1.6-0.42-2.56-2.06-2.15-3.66 c0.42-1.6,2.06-2.56,3.66-2.14c11.65,3.04,24.21-0.21,32.78-8.48c1.19-1.15,3.09-1.12,4.24,0.08c1.15,1.19,1.12,3.09-0.08,4.24 C84.54,100.85,74.32,104.82,63.91,104.82z" style="fill:#2F2F2F;"/>
<path d="M55.53,67.26c-0.01,0.01-0.02,0.02-0.02,0.02C55.51,67.27,55.52,67.26,55.53,67.26z" style="fill:#2F2F2F;"/>
<g>
<path d="M98.21,41.34c-13.36,0-15.15,2.03-21.4,3.36C70.56,46.02,64,46.02,64,46.02s-6.56,0-12.81-1.33 c-6.25-1.33-8.05-3.36-21.4-3.36c-13.36,0-29.37,2.89-29.37,2.89v8.51c0,0,3.59,0.47,3.91,3.75c0.16,1.33-3.12,28.35,23.51,28.35 c18.9,0,26.87-11.33,29.45-20.54c1.17-4.37,2.19-9.37,6.72-9.37c4.53,0,5.55,5,6.72,9.37c2.58,9.22,10.54,20.54,29.45,20.54 c26.63,0,23.35-27.03,23.51-28.35c0.31-3.28,3.91-3.75,3.91-3.75v-8.51C127.58,44.23,111.57,41.34,98.21,41.34z" style="fill:#2F2F2F;"/>
<path d="M95.94,45.05c-6.62,0.23-11.65,1.31-11.65,1.31c-9.84,2.06-10.55,8.14-9.93,12.97 c0.8,6.07,3.29,13.75,10.04,18.49c0.53,0.38,1.76,0.79,2.35-0.77c0,0-0.02,0.11,0,0c2.22-10.48,5.52-20.14,10.78-29.89l0,0 C98.14,45.37,96.71,45.02,95.94,45.05z" style="fill:#FFFFFF;"/>
<path d="M31.06,45.02c-4.27-0.09-9.11,0.19-13.65,1.34c-5.1,1.28-7.07,3.85-7.6,9.39 c-0.53,5.43-1.13,19.27,8.73,24.46c0.57,0.3,1.83,0.5,2.44-0.91l0,0C24,66.21,25.61,60.13,32.54,47.22l0,0 C33.11,45.49,31.83,45.03,31.06,45.02z" style="fill:#FFFFFF;"/>
</g>
</svg>

After

Width:  |  Height:  |  Size: 1.7 KiB

View File

Before

Width:  |  Height:  |  Size: 511 KiB

After

Width:  |  Height:  |  Size: 511 KiB

View File

@ -1,51 +0,0 @@
# MinIO 存储模块
简化的 MinIO 对象存储模块,提供基本的文件存储功能。
## 核心功能
### 基本使用
```python
from src.storage.minio import upload_image_to_minio
# 上传图片(保持原有接口)
url = upload_image_to_minio(image_data, "jpg")
print(f"图片已上传: {url}")
```
### 高级使用
```python
from src.storage.minio import MinIOClient, get_minio_client
# 获取客户端实例
client = get_minio_client()
# 上传文件
with open("example.txt", "rb") as f:
data = f.read()
result = client.upload_file("my-bucket", "example.txt", data)
print(f"文件已上传: {result.url}")
# 下载文件
downloaded_data = client.download_file("my-bucket", "example.txt")
# 删除文件
client.delete_file("my-bucket", "example.txt")
```
## 功能特性
- ✅ **向后兼容**:保持 `upload_image_to_minio` 函数的原有接口
- ✅ **简洁易用**:核心功能一目了然
- ✅ **错误处理**:统一的异常处理
- ✅ **类型安全**:完整的类型注解
## 架构优势
1. **职责清晰**`src/storage/minio` 专门处理对象存储
2. **易于维护**:代码简洁,功能明确
3. **易于扩展**:为未来功能扩展留出空间
4. **向后兼容**:不破坏现有代码