{"id":27218296,"url":"https://github.com/pumbas600/github-contributions","last_synced_at":"2025-04-10T05:37:27.306Z","repository":{"id":181599410,"uuid":"621574502","full_name":"pumbas600/github-contributions","owner":"pumbas600","description":"⚡Dynamically generated GitHub contribution graphs for your README!","archived":false,"fork":false,"pushed_at":"2024-12-19T07:50:06.000Z","size":779,"stargazers_count":10,"open_issues_count":8,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-19T08:34:28.985Z","etag":null,"topics":["contributions","github"],"latest_commit_sha":null,"homepage":"https://github.pumbas.net/","language":"TypeScript","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/pumbas600.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-31T00:12:06.000Z","updated_at":"2024-12-19T07:48:02.000Z","dependencies_parsed_at":"2023-07-16T12:41:16.170Z","dependency_job_id":"fe5938a0-79d9-4f81-92f4-5bad27ac6105","html_url":"https://github.com/pumbas600/github-contributions","commit_stats":null,"previous_names":["pumbas600/github-contributions"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pumbas600%2Fgithub-contributions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pumbas600%2Fgithub-contributions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pumbas600%2Fgithub-contributions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pumbas600%2Fgithub-contributions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pumbas600","download_url":"https://codeload.github.com/pumbas600/github-contributions/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248164894,"owners_count":21058231,"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":["contributions","github"],"created_at":"2025-04-10T05:37:26.615Z","updated_at":"2025-04-10T05:37:27.286Z","avatar_url":"https://github.com/pumbas600.png","language":"TypeScript","readme":"[![pumbas600's Contributions](https://github.pumbas.net/api/contributions/pumbas600?bgColour=161B22#gh-dark-mode-only)](https://github.com/pumbas600/github-contributions#gh-dark-mode-only)\n[![pumbas600's Contributions](https://github.pumbas.net/api/contributions/pumbas600?colour=002AFF\u0026bgColour=F6F8FA#gh-light-mode-only)](https://github.com/pumbas600/github-contributions#gh-light-mode-only)\n\n\n\u003cdiv align=\"center\"\u003e\n    \u003ch1\u003eGitHub Contributions\u003c/h1\u003e\n    \u003cimg alt=\"Graphs generated last week\" src=\"https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fgithub.pumbas.net%2Fapi%2Fmetrics%3Fdays%3D7\u0026query=%24.count\u0026suffix=%20graphs\u0026label=last%20week\u0026labelColor=%235d5d5d\" /\u003e\n    \u003cimg alt=\"Graphs generated in total\" src=\"https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fgithub.pumbas.net%2Fapi%2Fmetrics\u0026query=%24.count\u0026suffix=%20graphs\u0026label=in%20total\u0026labelColor=%235d5d5d\" /\u003e\n\u003c/div\u003e\n\n### [View GitHub Contributions Playground](https://github.pumbas.net)\n\nThis is a simple project that lets you to render your recent GitHub contributions as a graph that can be embedded in your README.  To get started, have a look at the [Github Contributions Playground](https://github.pumbas.net) to quickly create and view your contributions graph.\n\nAll examples in this README can be simply pasted into your README with `YOUR_GITHUB_USERNAME` changed to be your username (case-insensitive).\n\n```md\n![YOUR_GITHUB_USERNAME's Contributions](https://github.pumbas.net/api/contributions/YOUR_GITHUB_USERNAME)\n```\n\nThis can also be used in HTML images:\n\n```html\n\u003cimg src=\"https://github.pumbas.net/api/contributions/YOUR_GITHUB_USERNAME\" alt=\"YOUR_GITHUB_USERNAME's Contributions\"/\u003e\n```\n\nIt works through a simple API that generates an SVG which can be used as an image in markdown. It utilises the amazing chart library [recharts](https://www.npmjs.com/package/recharts) to generate the graph.\n\n## Customisation\n\nThere is also support for a number of options which allow you to style the graph to your hearts content. Each option can be configured through the use of query parameters in the url.\n\n\u003e [!NOTE]\n\u003e All colours are hexcodes without the starting '#'. E.g. `#4BB5FC` → `4BB5FC`.\n\nQuery Parameter | Description             | Type    | Default Value\n----------------|-------------------------|---------|-----------------\n`colour`        | The colour of the line and text. A partially transparent version of this colour is used for the shaded area and grid | Hexcode | `4BB5FC`\n`bgColour`      | The background colour of the graph | Hexcode or `transparent` | `transparent`\n`dotColour`     | The colour of the dots for each day's contributions | Hexcode | `E5E5E5`\n`days`          | The past number of days to include in your contributions graph | Positive number that's ≤ 365 | `30`\n`borderRadius`  | The card's border radius           | Positive number          | `4.5`\n\nAn example using some of these looks like:\n\n```md\n![YOUR_GITHUB_USERNAME's Contributions](https://github.pumbas.net/api/contributions/YOUR_GITHUB_USERNAME?colour=DF9149\u0026bgColour=161B22\u0026dotColour=D04E4E)\n```\n\n![pumbas600's Contributions](https://github.pumbas.net/api/contributions/pumbas600?colour=DF9149\u0026bgColour=161B22\u0026dotColour=D04E4E)\n\n## Respecting User's Themes\n\nIt is recommended to use the [`#gh-light-mode-only` or `#gh-dark-mode-only`](https://github.blog/changelog/2021-11-24-specify-theme-context-for-images-in-markdown/) fragments so that you can change the styling based on the user's theme. They simply need to be appended to the end of markdown URLs and they will not be rendered unless their respective mode is active.\n\n```md\n\u003c!-- Dark mode image --\u003e\n[![YOUR_GITHUB_USERNAME's Contributions](https://github.pumbas.net/api/contributions/YOUR_GITHUB_USERNAME?bgColour=161B22#gh-dark-mode-only)](https://github.com/pumbas600/github-contributions#gh-dark-mode-only)\n\n\n\u003c!-- Light mode image --\u003e\n[![YOUR_GITHUB_USERNAME's Contributions](https://github.pumbas.net/api/contributions/YOUR_GITHUB_USERNAME?colour=002AFF\u0026bgColour=F6F8FA#gh-light-mode-only)](https://github.com/pumbas600/github-contributions#gh-light-mode-only)\n```\n\n\u003e [!IMPORTANT]\n\u003e For some reason, it only works on the API URL in VS Code, To get it to behave correctly on GitHub, you need to wrap it in another URL with the fragment applied.\n\nGitHub has also added support for the [`prefers-color-scheme` media query](https://github.blog/changelog/2022-05-19-specify-theme-context-for-images-in-markdown-beta/), which can be used in conjunction with the HTML [`\u003cpicture\u003e`](https://www.w3schools.com/TAGS/tag_picture.asp) tags to allow you to change the image you display based on the user's theme.\n\n```html\n\u003cpicture\u003e\n    \u003c!-- Dark mode image --\u003e\n    \u003csource\n        srcset=\"https://github.pumbas.net/api/contributions/YOUR_GITHUB_USERNAME?bgColour=161B22\"\n        media=\"(prefers-color-scheme: dark)\"\n    /\u003e\n    \u003c!-- Default, light mode image --\u003e\n    \u003cimg \n        src=\"https://github.pumbas.net/api/contributions/YOUR_GITHUB_USERNAME?colour=002AFF\u0026bgColour=F6F8FA\"\n        alt=\"YOUR_GITHUB_USERNAME's Contributions\"\n    /\u003e\n\u003c/picture\u003e\n```","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpumbas600%2Fgithub-contributions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpumbas600%2Fgithub-contributions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpumbas600%2Fgithub-contributions/lists"}