📷 Show your dynamically generated GitHub contributions to your GitHub profile or your website!
Easily showcase your GitHub contributions to your profile! Follow the steps below:
- Copy the code snippet below and paste it into your
README.mdfile. - Replace
/oxwazzwith your GitHub username (case-insensitive).
Output
Congratulation! 🎉 You are now showing your GitHub contributions to your profile!
You can use additional params for customize your needs.
| Description | Query Params | Default Value | Possible Value |
|---|---|---|---|
| filter by PR states | ?states= | - | "MERGED" | "OPEN" | "CLOSED" |
| Custom widget title | ?title= | - | string |
| Custom showing total contribution | ?show-max= | 3 | number (min=1 max=10) |
| Custom theme | ?theme= | light | "light" | "dark" |
and you can combine all the query params. 💪
1. why the widget is not updating? that causing my latest contributions not listed
GitHub has image caching by default, this causing your latest contributions not reflect on this widget. to solve this issue you can manually update the image using query params like
?refresh-cache=1or you can update?refresh-cache=automatically using GitHub Action cronjob with probablykasper/readme-template-action, you can see the example in my repository.
🎈 Thanks for your help improving the project! We are so happy to have you! We have a contributing guide to help you get involved in the project.
MIT License © 2024-PRESENT Muhammad Rahmahalim