{"id":22506160,"url":"https://github.com/oxwazz/github_contributions_widget","last_synced_at":"2026-02-06T08:05:54.467Z","repository":{"id":266766141,"uuid":"898897848","full_name":"oxwazz/github_contributions_widget","owner":"oxwazz","description":"💡 Showcase your github open-source contributions dynamically!","archived":false,"fork":false,"pushed_at":"2025-01-20T04:57:57.000Z","size":2052,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-20T05:29:26.768Z","etag":null,"topics":["card","dynamically","github","oss","profile","showcase","stats"],"latest_commit_sha":null,"homepage":"https://github-contributions-widget.oxwazz.com/oxwazz","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oxwazz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-05T08:45:14.000Z","updated_at":"2025-01-20T04:57:58.000Z","dependencies_parsed_at":"2025-01-01T01:20:00.842Z","dependency_job_id":"fa08bc16-614e-43a2-8d50-d98dafbd007d","html_url":"https://github.com/oxwazz/github_contributions_widget","commit_stats":null,"previous_names":["oxwazz/github_contributions_widget"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxwazz%2Fgithub_contributions_widget","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxwazz%2Fgithub_contributions_widget/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxwazz%2Fgithub_contributions_widget/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxwazz%2Fgithub_contributions_widget/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oxwazz","download_url":"https://codeload.github.com/oxwazz/github_contributions_widget/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":236742366,"owners_count":19197503,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["card","dynamically","github","oss","profile","showcase","stats"],"created_at":"2024-12-07T00:41:21.327Z","updated_at":"2025-10-16T19:30:49.102Z","avatar_url":"https://github.com/oxwazz.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GitHub Contributions Widget\n\n[badge-workflow]: https://img.shields.io/github/actions/workflow/status/oxwazz/github_contributions_widget/release.yml\n\n[link-workflow]: https://github.com/oxwazz/github_contributions_widget/actions/workflows/release.yml\n\n[badge-twitter]: https://img.shields.io/twitter/follow/oxwazz\n\n[link-twitter]: https://x.com/oxwazz\n\n[![badge-workflow]][link-workflow]\n[![badge-twitter]][link-twitter]\n\n📷 Show your dynamically generated GitHub contributions to your GitHub profile or your website!\n\n### Contents\n\n- [Usage](#usage)\n    - [Optional Query Params](#optional-query-params)\n- [FAQ](#faq)\n- [Why](#why)\n- [Limitation](#limitation)\n- [Contributing](#contributing)\n- [Credit](#credit)\n- [License](#license)\n\n## Usage\n\n🎩 Easily showcase your GitHub contributions to your profile! Follow the steps below:\n\n1. Copy the code snippet below and paste it into your `README.md` file.\n1. Replace `/oxwazz` with your GitHub username (case-insensitive).\n\n```markdown\n![GitHub Contributions Widget](https://github-contributions-widget.oxwazz.com/oxwazz)\n```\n\n**Output** \u003cbr/\u003e\n![GitHub Contributions Widget](./assets/snapshot/v0.1.3.svg)\n\nCongratulation! 🎉 You are now showing your GitHub contributions to your profile!\n\n### Optional Query Params\n\n🧪 You can use additional params for customize your needs.\n\n| Description                       | Query Params | Default Value | Possible Value                 |\n|-----------------------------------|--------------|---------------|--------------------------------|\n| filter by PR states               | ?states=     | -             | \"MERGED\" \\| \"OPEN\" \\| \"CLOSED\" |\n| custom widget title               | ?title=      | -             | string                         |\n| custom showing total contribution | ?show-max=   | 3             | number (min=1 max=10)          |\n| custom theme                      | ?theme=      | light         | \"light\" \\| \"dark\"              |\n\nand you can combine all the query params. 💪\n\n## FAQ\n\n**1. why is my widget not updating, causing my latest contributions not to be listed?**\n\n\u003e GitHub has image caching by default, this causing your latest contributions not reflect on this widget.\n\u003e to solve this issue you can manually update the image using query params like `?refresh-cache=1`\n\u003e or you can update `?refresh-cache=` automatically using GitHub Action cronjob\n\u003e with [probablykasper/readme-template-action](https://github.com/probablykasper/readme-template-action),\n\u003e you can [see the example](https://github.com/oxwazz/oxwazz) in my repository.\n\n**2. can we use a widget theme based on the browser's light or dark mode?**\n\n\u003e\nYes, [GitHub markdown has support for light and dark mode images](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#specifying-the-theme-an-image-is-shown-to).\n\u003e You can implement a widget that changes its theme depending on the browser's mode using the \\\u003cpicture\\\u003e element.\n\u003e ```markdown\n\u003e \u003cpicture\u003e\n\u003e   \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://github-contributions-widget.oxwazz.com/oxwazz?theme=dark\"\u003e\n\u003e   \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://github-contributions-widget.oxwazz.com/oxwazz\"\u003e\n\u003e   \u003cimg alt=\"show widget theme based on browser light or dark mode.\" src=\"https://github-contributions-widget.oxwazz.com/oxwazz\"\u003e\n\u003e \u003c/picture\u003e\n\u003e ```\n\n## Why\n\n🖌️ We create this widget to effortlessly display your GitHub contributions on your profile, highlighting your coding\nactivity and accomplishments to potential collaborators, employers, or your community. It provides a visually appealing\nway to showcase your commitment to open source and personal projects, enhancing your professional presence.\n\n## Limitation\n\n📐 This code is deployed on a [Cloudflare worker](https://developers.cloudflare.com/workers/languages/rust/). As we are\nutilizing the free tier, there\nare [certain limitations](https://developers.cloudflare.com/workers/platform/limits/#worker-limits)\nassociated with it. Additionally, it interacts with\nthe [GitHub API](https://docs.github.com/en/graphql/overview/about-the-graphql-api),\nwhich also\nhas [usage limits](https://docs.github.com/en/graphql/overview/rate-limits-and-node-limits-for-the-graphql-api#node-limit)\nin place.\n\n## Contributing\n\n🎈 Thanks for your help improving the project! We are so happy to have you! We have a\n[contributing guide](./CONTRIBUTING.md) to help you get involved in the project.\n\n## Credit\n\n📌 GitHub Contributions Widget is currently being developed and maintained\nby [Muhammad Rahmahalim](https://github.com/oxwazz).\u003cbr\u003e\nThis project is inspired by [LeetCode-Stats-Card](https://github.com/JacobLinCool/LeetCode-Stats-Card), but focuses on\nshowcasing GitHub open-source contributions instead of LeetCode progress. Thank you!\n\n## License\n\n[MIT](./LICENSE) License © 2024 [Muhammad Rahmahalim](https://github.com/oxwazz)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxwazz%2Fgithub_contributions_widget","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foxwazz%2Fgithub_contributions_widget","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxwazz%2Fgithub_contributions_widget/lists"}