GitHub README Generator

An open source, AI-powered documentation generator for any public GitHub repository. Paste a repo URL, select a doc type, and get a complete markdown document in seconds.

Live demo: github-docs-generator

---

Features

• Generates comprehensive README and concise Quickstart documentation
• Recursively inspects repository structure and selects high-value source files
• Summarizes large files in bounded chunks before generating evidence-based docs
• Powered by Google Gemini 2.5 Flash via secure backend proxies
• No API key required for end users
• Clean, responsive dark UI

---

Tech stack

Layer	Technology
Frontend	HTML, CSS, JavaScript (vanilla)
Backend	Vercel Serverless Function (Node.js)
AI	Google Gemini 2.5 Flash
Hosting	Vercel (free tier)

---

Project structure

github-docs-generator/
├── public/
│   ├── index.html
│   ├── styles.css
│   └── app.js
├── api/
│   ├── lib/
│   ├── inspect.js
│   ├── analyze.js
│   └── generate.js
├── test/
├── .env              ← gitignored
├── .gitignore
├── vercel.json
├── DEPLOY.md
└── README.md

---

Local development

Prerequisites

• Node.js v18 or higher
• Vercel CLI: npm install -g vercel
• A free Gemini API key from aistudio.google.com/apikey

Setup

1. Clone the repo:

git clone https://github.com/manueldezman/github-docs-generator.git
cd github-docs-generator

2. Create a .env file in the root:

GEMINI_API_KEY=your_gemini_api_key_here
GITHUB_TOKEN=your_github_token_here

The GitHub token only needs read access to public repositories. It is used server-side to improve API rate limits and is never sent to the browser.

3. Start the local dev server:

vercel dev

4. Open http://localhost:3000 in your browser.

---

Deployment

See DEPLOY.md for the full step-by-step guide to deploying on Vercel.

---

Contributing

Contributions are welcome! Here's how to get started:

1. Fork the repository
2. Create a new branch: git checkout -b feature/your-feature-name
3. Make your changes
4. Commit: git commit -m "feat: describe your change"
5. Push: git push origin feature/your-feature-name
6. Open a Pull Request

Good first issues

• Add a light mode toggle
• Improve mobile responsiveness

Commit message format

Use conventional commits:

feat: add new doc type
fix: handle private repo error gracefully
style: update button hover state
docs: update README

---

License

MIT — free to use, modify, and distribute.

---

Built by 0xdezman