deepwiki-open README

The project's README from github.com/AsyncFuncAI/deepwiki-open. As one markdown file: README.md.

DeepWiki-Open (Grok-Wiki)

grok-wiki

DeepWiki is my own implementation attempt of DeepWiki, automatically creates beautiful, interactive wikis for any GitHub, GitLab, or BitBucket repository! Just enter a repo name, and DeepWiki will:

  1. Analyze the code structure
  2. Generate comprehensive documentation
  3. Create visual diagrams to explain how everything works
  4. Organize it all into an easy-to-navigate wiki
  5. Generate codemap for code-centric guided tours

Tip in Crypto Twitter/X Discord

English | 简体中文 | 繁體中文 | 日本語 | Español | 한국어 | Tiếng Việt | Português Brasileiro | Français | Русский

Deepwiki-Open 2.0 (Grok Wiki is now live)

https://github.com/user-attachments/assets/48d1e60a-eb91-4c05-a5a8-3624ffb79fb1

🤝 Contributing

Contributions are welcome! Feel free to:

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

⭐ Star History

Star History Chart

deepwiki-open (AsyncFuncAI/deepwiki-open)

Searching Database…

这是什么?DeepWiki-Open 是一个开源的、由 AI 驱动的 wiki 生成器:给它一个 GitHub、GitLab 或 Bitbucket 仓库,它会自动生成一个美观、可交互的 wiki,讲解代码是如何工作的。
那它是一个托管网站,还是需要我自己部署运行的?需要你自己部署,它是一个自托管(Web 应用:基于 Next.js 的界面,在浏览器中通过 3000 端口访问,并支持用 Docker 和 Docker Compose 部署到服务器。README 中还宣布 DeepWiki-Open 2.0(Grok Wiki)已可下载体验。
我怎么把它跑起来?克隆仓库后用 Docker Compose 启动(仓库的 CI 里已经接入了 Docker 镜像构建),或者运行 npm run dev 启动带 Turbopack 的 Next.js 开发服务器,应用会在 localhost:3000 上运行起来。
它需要付费的 AI API 吗,还是可以用本地模型运行?根据仓库的话题标签,它支持多种 AI 后端,OpenAI、Google Gemini、OpenRouter 和 Ollama,所以你既可以填入托管服务的 API 密钥,也可以指向本地的 Ollama 模型;至少需要配置一个服务商。
我刚接手一个大型的代码库,它能帮我快速上手吗?这正是它的主要用途:DeepWiki 会分析代码结构,生成全面的文档,绘制展示整体运作方式的可视化图表,并附带一份 codemap 和以代码为中心的引导式讲解,全部整理成一个可浏览导航的 wiki。
可以免费使用吗?可以,它采用 MIT 许可证,可以免费使用、修改和自托管,也允许商用。
作者为什么不直接用原版的 DeepWiki,而是自己做一个?这是作者自己对 DeepWiki 的开源实现尝试,采用 MIT 许可证、支持自托管,任何人都可以查看、运行和扩展它,而不必依赖一个托管服务。该项目目前在 GitHub 上已获得 18k+ 星标。
生成的 wiki 里的图表是用什么渲染的?Mermaid——前端技术栈在 Next.js/React 界面的基础上使用了 mermaid 库,所以可视化讲解会以可交互的 Mermaid 图表形式呈现。
我可以用自己的语言来使用它吗?应该可以,README 提供了十种语言版本(英语、简体中文和繁体中文、日语、西班牙语、韩语、越南语、葡萄牙语、法语、俄语),而且应用使用了 next-intl,界面本身就做了本地化。
What are similar projects?oxynote, gitdiagram, sim, Skill_Seekers, job-ops, opencodex, mike, WeKnora
Size
4.4 MB
Stars
18.2K
Updated
CommitSep 03
Age
1y
Commits · 90 Days