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
- Generates 2 documentation types: README and Quickstart.
- Fetches real repo metadata, file structure, and existing README from the GitHub public API
- Powered by Google Gemini 2.5 Flash via a secure backend proxy
- No API key required for end users
- Clean, responsive dark UI
| Layer | Technology |
|---|---|
| Frontend | HTML, CSS, JavaScript (vanilla) |
| Backend | Vercel Serverless Function (Node.js) |
| AI | Google Gemini 2.5 Flash |
| Hosting | Vercel (free tier) |
github-docs-generator/
├── public/
│ ├── index.html
│ ├── styles.css
│ └── app.js
├── api/
│ └── generate.js
├── .env ← gitignored
├── .gitignore
├── vercel.json
├── DEPLOY.md
└── README.md
- Node.js v18 or higher
- Vercel CLI:
npm install -g vercel - A free Gemini API key from aistudio.google.com/apikey
- Clone the repo:
git clone https://github.com/manueldezman/github-docs-generator.git
cd github-docs-generator- Create a
.envfile in the root:
GEMINI_API_KEY=your_gemini_api_key_here- Start the local dev server:
vercel dev- Open
http://localhost:3000in your browser.
See DEPLOY.md for the full step-by-step guide to deploying on Vercel.
Contributions are welcome! Here's how to get started:
- Fork the repository
- Create a new branch:
git checkout -b feature/your-feature-name - Make your changes
- Commit:
git commit -m "feat: describe your change" - Push:
git push origin feature/your-feature-name - Open a Pull Request
- Add a light mode toggle
- Improve mobile responsiveness
Use conventional commits:
feat: add new doc type
fix: handle private repo error gracefully
style: update button hover state
docs: update README
MIT — free to use, modify, and distribute.
Built by 0xdezman