-
-
Notifications
You must be signed in to change notification settings - Fork 8.1k
Description
📝 Description
Currently, the GitHub Profile README Generator does not provide any option to add or select GIFs. Users can only use static images or emojis.
This feature proposes adding a GIFs section where users can choose from a set of default animated GIFs or upload/add their own GIFs to include in their generated README.
🎯 Problem Statement
Users often want to make their GitHub profiles more expressive and engaging.
However, since there’s no built-in support for GIFs, they must manually find and embed GIF links — which can be inconvenient and discouraging for beginners.
A simple built-in gallery would make it easier to personalize READMEs without needing external sites or markdown expertise.
💡 Proposed Solution
Add a GIFs gallery feature to the generator that provides:
A collection of preloaded default GIFs (coding, greetings, celebration, etc.).
A button to add or upload custom GIFs by pasting a GIF URL or uploading a local file.
An option to preview and insert the selected GIF into the README preview and final markdown.
🔄 User Flow
User opens the Customization or Media section in the generator.
Clicks the “Add GIF” button.
A gallery modal appears with default GIFs displayed.
User can:
Select from default GIFs, or
Click “Add Custom GIF” to upload or paste a URL.
The chosen GIF is previewed and inserted automatically into the README layout.
🎨 Design Considerations
Add a clean, responsive GIFs gallery modal.
Include “Add Custom GIF” and “Preview” options.
Maintain compatibility with both dark and light themes.
Ensure easy navigation and visibility on mobile and desktop devices.
🔧 Technical Considerations
Store a small library of default GIFs locally within the project or CDN.
Support both file upload (for small GIFs) and external link embedding.
Ensure no significant performance impact (lazy load or compressed GIFs).
Validate file formats and sizes for uploads.
No breaking changes to current README generation flow.
📋 Alternative Solutions
📸 Mockup/Example Idea
A modal with:
Tabs for “Default GIFs” and “Custom GIFs.”
A grid layout displaying available GIFs with a Select button.
“Upload / Add URL” input field for user-added GIFs.
🎯 Priority
- Low - Optional enhancement
- Medium - Enhances customization & visual appeal
- High - Major user experience upgrade
- Critical - Blocking functionality
📱 Target Platforms
- Desktop
- Mobile
- Tablet
- All platforms
🏷️ Additional Note
I would like to work on this feature and request to be assigned to me under Hacktoberfest. 🚀
