AIDotNet/OpenDeepWiki
OpenDeepWiki is the open-source version of the DeepWiki project, aiming to provide a powerful knowledge management and collaboration platform. The project is mainly developed using C# and TypeScript, supporting modular design, and is easy to expand and customize.
解决的问题
保持项目文档最新是繁琐的,而且常常与代码不同步。OpenDeepWiki 通过摄取仓库(来自 Git、ZIP 或本地文件夹)并使用 AI 生成结构化的 wiki 内容(README、概述、目录、详细文档,甚至思维导图)来自动化这一过程。然后,它通过网站、聊天助手和 MCP(模型上下文协议)端点公开这些知识,使人类和 AI 代理能够查询仓库的文档。
工作原理
- 导入:您提供 Git URL、上传 ZIP 或指向已批准的本地目录。系统会规范化源并准备工作区。
- 分析与生成:它分析树结构和现有仓库上下文,然后使用配置的 LLM 提供商(例如,兼容 OpenAI 的 API)生成 README 摘要、概述、wiki 目录和文档内容。翻译成多种语言(en、zh、ja、ko、es、fr 等)是可选的,并且可以并行运行。
- 丰富:后台工作器处理后续任务——翻译、思维导图生成(Mermaid)、可选的 Graphify 工件,以及仓库更改时的计划增量更新。
- 服务:生成的知识发布在公共路由上,如 /{owner}/{repo},通过内置聊天 UI、可嵌入的聊天 API、分享链接和仓库范围的 MCP 端点(例如,/api/mcp/{owner}/{repo})公开。管理员从管理控制台管理用户、角色、API 密钥、AI 提供商、模型、技能等。
后端是 ASP.NET Core(.NET 10)和后台工作器;前端是 Next.js 16;数据存储是 SQLite 或 PostgreSQL;部署通过 Docker Compose。
适用对象
- 希望无需手动工作即可获得自动生成、最新项目文档的开发团队。
- 需要为其仓库提供公共文档的开源维护者。
- 希望为 AI 代理提供基于角色的访问、聊天和 MCP 集成的内部知识库的企业。
- 使用多个仓库并希望获得支持多语言的集中式 wiki 的组织。
亮点
- 接受 Git URL、ZIP 上传或本地目录作为源。
- AI 生成的 README、概述、wiki 目录、详细内容、翻译和思维导图。
- 每个仓库的公开 SEO 友好路由,以及专用聊天助手和可嵌入的聊天 API。
- MCP 端点(仓库范围或全局)供 AI 工具访问仓库知识。
- 管理控制台,用于管理仓库、用户、角色、API 密钥、AI 提供商/模型、技能和 MCP 提供商。
- 后台工作器,用于处理、翻译、增量更新和 Graphify 工件生成。
- 可选支持飞书、QQ、微信和 Slack 传入 Webhook。
- 使用 SQLite 或 PostgreSQL 的 Docker Compose 部署,以及 Makefile 和 Sealos 选项。
相关
- 项目
- 项目
- 项目
- 项目
- 项目