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…

What is this?DeepWiki-Open is an open-source, AI-powered wiki generator: give it a GitHub, GitLab, or Bitbucket repository and it automatically builds a beautiful, interactive wiki explaining how the code works.
So is it a hosted website, or something I run myself?You run it yourself as a self-hosted web app: a Next.js UI in your browser served on port 3000, with Docker and Docker Compose support for server deployments. The README also announces DeepWiki-Open 2.0 (Grok Wiki) as a live download.
How do I get it running?Clone the repo and start it with Docker Compose (a Docker image build is wired into the repo's CI), or run npm run dev to launch the Next.js dev server with Turbopack — the app comes up at localhost:3000.
Does it need a paid AI API, or can it run on a local model?It supports several AI backends per the repo's topics — OpenAI, Google Gemini, OpenRouter, and Ollama — so you can plug in a hosted API key or point it at a local Ollama model; you need at least one provider configured.
I just inherited a large codebase — would this help me get up to speed?That's the main use case: DeepWiki analyzes the code structure, generates comprehensive documentation, draws visual diagrams of how everything works, and adds a codemap with code-centric guided tours, all organized into a navigable wiki.
Is it free to use?Yes — MIT licensed, so it is free to use, modify, and self-host, including commercially.
Why did the author build this instead of using the original DeepWiki?It's the author's own open-source implementation attempt of DeepWiki — an MIT-licensed, self-hostable take on the idea, so anyone can inspect, run, and extend it rather than depend on a hosted service. It has since grown to 18k+ GitHub stars.
What renders the diagrams inside a generated wiki?Mermaid — the frontend stack includes the mermaid library on top of a Next.js/React UI, so the visual explanations come out as interactive Mermaid diagrams.
Can I use it in my own language?Likely yes — the README ships in ten languages (English, Simplified and Traditional Chinese, Japanese, Spanish, Korean, Vietnamese, Portuguese, French, Russian), and the app uses next-intl, so the UI itself is localized.
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