diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 769b50c5..b0530d42 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -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: '下一页' + } }, }) diff --git a/docs/images/add_custom_model.png b/docs/images/add_custom_model.png deleted file mode 100644 index 9d62f666..00000000 Binary files a/docs/images/add_custom_model.png and /dev/null differ diff --git a/docs/images/custom_models.png b/docs/images/custom_models.png deleted file mode 100644 index 24e8aa62..00000000 Binary files a/docs/images/custom_models.png and /dev/null differ diff --git a/docs/images/graph_vis.png b/docs/images/graph_vis.png deleted file mode 100644 index 1974226d..00000000 Binary files a/docs/images/graph_vis.png and /dev/null differ diff --git a/docs/images/knowledge_bases.png b/docs/images/knowledge_bases.png deleted file mode 100644 index 34cd62e3..00000000 Binary files a/docs/images/knowledge_bases.png and /dev/null differ diff --git a/docs/images/lightrag_kb.png b/docs/images/lightrag_kb.png deleted file mode 100644 index 8eee4617..00000000 Binary files a/docs/images/lightrag_kb.png and /dev/null differ diff --git a/docs/images/main.png b/docs/images/main.png deleted file mode 100644 index 54e9fb22..00000000 Binary files a/docs/images/main.png and /dev/null differ diff --git a/docs/images/reasoning.png b/docs/images/reasoning.png deleted file mode 100644 index 54522a06..00000000 Binary files a/docs/images/reasoning.png and /dev/null differ diff --git a/docs/images/select_model.png b/docs/images/select_model.png deleted file mode 100644 index a47d824c..00000000 Binary files a/docs/images/select_model.png and /dev/null differ diff --git a/docs/index.md b/docs/index.md index 1971558c..b3448665 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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 +``` \ No newline at end of file diff --git a/docs/intro/quick-start.md b/docs/intro/quick-start.md index 416abddd..8ed21845 100644 --- a/docs/intro/quick-start.md +++ b/docs/intro/quick-start.md @@ -293,6 +293,7 @@ vllm serve BAAI/bge-reranker-v2-m3 \ 知识图谱可视化 知识库可视化 + @@ -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) 文件了解详情。 - ---- - -
- -**如果这个项目对您有帮助，请不要忘记给我们一个 ⭐️** - -[报告问题](https://github.com/xerrors/Yuxi-Know/issues) | [功能请求](https://github.com/xerrors/Yuxi-Know/issues) | [讨论](https://github.com/xerrors/Yuxi-Know/discussions) - -
diff --git a/docs/public/bb.png b/docs/public/bb.png new file mode 100644 index 00000000..6f073577 Binary files /dev/null and b/docs/public/bb.png differ diff --git a/docs/public/favicon.svg b/docs/public/favicon.svg new file mode 100644 index 00000000..4ab98879 --- /dev/null +++ b/docs/public/favicon.svg @@ -0,0 +1,10 @@ + + + + + + + + + + \ No newline at end of file diff --git a/docs/images/neo4j_browser.png b/docs/public/images/neo4j_browser.png similarity index 100% rename from docs/images/neo4j_browser.png rename to docs/public/images/neo4j_browser.png diff --git a/docs/usage/MinIO.md b/docs/usage/MinIO.md deleted file mode 100644 index 372fb4da..00000000 --- a/docs/usage/MinIO.md +++ /dev/null @@ -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. **向后兼容**：不破坏现有代码