你有没有过这种时候:团队新来了个同事,你想给他讲清楚项目结构,结果翻遍 README 还是说不明白?
你有没有过这种时候:自己半年前写的代码,现在打开 repo 一脸懵,连 main.py 是入口还是配置文件都得逐行猜?
你有没有过这种时候:客户要文档,你手动截图、写流程、画架构图,熬到凌晨三点,最后对方只扫了一眼就问“能不能再加个搜索”?
替代了哪些付费软件
它不直接对标某款标价软件,但干的是三类人长期掏钱的事:技术文档外包、SaaS 型代码知识库订阅、以及内部 Wiki 系统的定制开发。
你花几百块请人整理一次代码文档,它免费跑一遍就生成带导航、图表和搜索的完整 Wiki。
比如用 Confluence + 插件做代码文档,企业版起步年费 1500 美元;GitBook 团队版每月 30 美元起;还有不少公司专门采购 CodeSee、Sourcegraph 这类工具,单用户年费动辄上百美元。DeepWiki-Open 不卖账号、不收月费、不锁功能。
价格直接砍到零。
核心功能
- 把 GitHub/GitLab/Bitbucket 上任意公开或私有仓库,一键变成可点击、可搜索、带侧边栏导航的网页 Wiki —— 不用手写 Markdown,也不用学 Sphinx 或 Docusaurus。生成后是个标准 HTML 文件夹,含 index.html、assets/ 和 search.js,双击就能本地打开。
- 自动分析代码依赖和调用关系,生成类图、函数调用链、模块流向图。你看不懂的 import 链,它能画成一张清晰的图,点进去还能跳转到源码行。比如 Python 项目里,它会识别 from utils.auth import verify_token,并在图中把 verify_token 节点连向 auth.py 的对应函数定义位置。
- 不是堆文字,而是按“功能模块→核心类→关键方法”三级组织内容,每个页面顶部都有“上一节 / 下一节”按钮,像读一本技术书那样往下翻。模块页列出该模块所有类,类页列出所有方法,方法页附带签名、参数说明(若 docstring 存在)和调用示例(若测试文件中有用例)。
- 内置 codemap 功能,相当于给整个代码库配了个语音导游:选中某个类,它会告诉你“这个类负责处理 API 请求,被 UserController 调用,调用了 DatabaseHelper 和 Logger”。点击“UserController”,页面立刻跳转到其定义处,并高亮显示调用该类的那几行代码。
- 支持多语言 README 自动识别,中文 repo 也能正确提取标题和章节,虽然界面仍是英文,但生成的文档内容不会乱码或漏字。它会解析 README.md 中的 # 标题、## 子标题、代码块语言标识,甚至保留表格结构和列表缩进层级。
- 所有内容本地生成,你可以把最终产出的 HTML 文件夹直接扔进 Nginx 或 GitHub Pages,不依赖任何在线服务 —— 数据全程不出你的电脑。生成过程不上传代码,不调用外部 API,所有解析都在 Docker 容器内完成。
三步上手
- 去 GitHub 项目页(https://github.com/AsyncFuncAI/deepwiki-open)点右上角 “Code” → “Download ZIP”,解压后打开终端进入文件夹。注意别漏掉 docker-compose.yml 和 .env.example 文件,它们控制端口、缓存路径和默认语言。
- 确保你已安装 Docker,然后在终端里运行 docker-compose up -d,等待服务启动完成(首次运行会拉取镜像,稍慢一点)。启动成功后,终端会显示 “deepwiki-open-web-1 is up”,此时容器已在后台运行。
- 浏览器打开 http://localhost:8000,输入任意 GitHub 仓库地址(比如 AsyncFuncAI/deepwiki-open),点“Generate”,30 秒内就能看到生成的 Wiki 页面。生成完成后,页面左上角会出现“Export as ZIP”按钮,点它即可下载整套静态站点。
项目信息
AsyncFuncAI/deepwiki-open
GitHub
Open Source DeepWiki: AI-Powered Wiki Generator for GitHub/Gitlab/Bitbucket Repositories. Join the discord: https://discord.gg/gMwThUMeme
18.2k
Stars
2.0k
Forks
Python
MIT



