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

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

1. Clone the repo:

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

1. Create a .env file in the root:

GEMINI_API_KEY=your_gemini_api_key_here

1. Start the local dev server:

vercel dev

1. Open http://localhost:3000 in 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:

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

• 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