GitHub DeepWiki Button

A browser extension that adds a DeepWiki button to GitHub repositories

🚀 Get Started

Install

• Chrome: GitHub DeepWiki Button - Chrome Web Store
• Firefox: GitHub DeepWiki Button - Firefox Add-ons
• Edge: GitHub DeepWiki Button - Microsoft Edge Addons

What is DeepWiki?

DeepWiki is a powerful AI documentation tool by Cognition. It generates comprehensive documentation for any GitHub repository and allows you to chat with it - all for free for open-source projects!

Just change github.com to deepwiki.com in any repository URL to access it.

🔒 Privacy Policy

GitHub DeepWiki Button does not collect any data.

In the future, GitHub DeepWiki Button may add the ability to save user settings on your device, but that data will not be sent to the server.

In addition, the GitHub DeepWiki Button management account will not be transferred to a third party.

If you have any questions or inquiries regarding the privacy policy, please contact koukun0120@gmail.com.

Revised: April 29, 2025

💻 Development

Node.js 22 or higher is required for development.

Setup

1. Clone the repository:

   git clone https://github.com/yamadashy/github-deepwiki.git
   cd github-deepwiki

2. Install Node.js 22 or higher (Node.js official site or nvm is recommended).
3. Install dependencies:

   npm install

4. Start the development server:

   npm run dev

Main Commands

Development extension for each browser.

npm run dev chrome
npm run dev firefox
npm run dev edge

Build extension for each browser.

npm run build chrome
npm run build firefox
npm run build edge

Lint code.

npm run lint

📜 License

This project is licensed under the MIT License.