{"id":13598401,"url":"https://github.com/Bloggify/github-calendar","last_synced_at":"2025-04-10T09:31:04.947Z","repository":{"id":41536846,"uuid":"49141073","full_name":"Bloggify/github-calendar","owner":"Bloggify","description":":bar_chart: Embed your GitHub calendar everywhere.","archived":false,"fork":false,"pushed_at":"2024-04-04T08:52:38.000Z","size":215,"stargazers_count":1262,"open_issues_count":14,"forks_count":213,"subscribers_count":12,"default_branch":"gh-pages","last_synced_at":"2025-04-06T15:11:11.811Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":"https://bloggify.github.io/github-calendar/example/","language":"JavaScript","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/Bloggify.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","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},"funding":{"github":"ionicabizau","patreon":"ionicabizau","open_collective":"ionicabizau","custom":"https://www.buymeacoffee.com/h96wwchmy"}},"created_at":"2016-01-06T14:50:03.000Z","updated_at":"2025-04-04T13:33:50.000Z","dependencies_parsed_at":"2024-09-21T05:02:23.664Z","dependency_job_id":null,"html_url":"https://github.com/Bloggify/github-calendar","commit_stats":{"total_commits":218,"total_committers":19,"mean_commits":"11.473684210526315","dds":"0.14220183486238536","last_synced_commit":"76bbf989df237223851a034921681c236218deb1"},"previous_names":["ionicabizau/github-calendar"],"tags_count":52,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bloggify%2Fgithub-calendar","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bloggify%2Fgithub-calendar/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bloggify%2Fgithub-calendar/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Bloggify%2Fgithub-calendar/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Bloggify","download_url":"https://codeload.github.com/Bloggify/github-calendar/tar.gz/refs/heads/gh-pages","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248191674,"owners_count":21062551,"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":["hacktoberfest"],"created_at":"2024-08-01T17:00:52.307Z","updated_at":"2025-04-10T09:31:04.347Z","avatar_url":"https://github.com/Bloggify.png","language":"JavaScript","readme":"\u003c!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. --\u003e\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n# github-calendar.js\n\n [![Version](https://img.shields.io/npm/v/github-calendar.svg)](https://www.npmjs.com/package/github-calendar) [![Downloads](https://img.shields.io/npm/dt/github-calendar.svg)](https://www.npmjs.com/package/github-calendar)\n\n\n\n\n\n\n\n\u003e Embed your GitHub contributions calendar anywhere.\n\n\n\n\n\n\n\nEverybody\u003csup\u003e\u003csup\u003ewell, haters gonna hate\u003c/sup\u003e\u003c/sup\u003e loves GitHub and everybody loves stats. So, why not making the GitHub contributions calendar available for being embeded in your web pages? Now [you can](https://bloggify.github.io/github-calendar/example). :tada:\n\n\n[![](https://i.imgur.com/tJjRpuN.png)](https://bloggify.github.io/github-calendar/example)\n\n\n\n\n\n\n\n\n\n\n\n\n\n## :cloud: Installation\n\n\nCheck out the [`dist`](/dist) directory to download the needed files and include them on your page.\n\nIf you're using this module in a CommonJS environment, you can install it using `npm` or `yarn` and `require` it:\n\n```sh\n# Using npm\nnpm install --save github-calendar\n\n# Using yarn\nyarn add github-calendar\n```\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n```html\n\u003c!-- Include the library. --\u003e\n\u003cscript\n  src=\"https://unpkg.com/github-calendar@latest/dist/github-calendar.min.js\"\u003e\n\u003c/script\u003e\n\n\u003c!-- Optionally, include the theme (if you don't want to struggle to write the CSS) --\u003e\n\u003clink\n  rel=\"stylesheet\"\n  href=\"https://unpkg.com/github-calendar@latest/dist/github-calendar-responsive.css\"\n/\u003e\n\n\u003c!-- Prepare a container for your calendar. --\u003e\n\u003cdiv class=\"calendar\"\u003e\n    \u003c!-- Loading stuff --\u003e\n    Loading the data just for you.\n\u003c/div\u003e\n\n\u003cscript\u003e\n    GitHubCalendar(\".calendar\", \"your-username\");\n\n    // or enable responsive functionality:\n    GitHubCalendar(\".calendar\", \"your-username\", { responsive: true });\n\n    // Use a proxy\n    GitHubCalendar(\".calendar\", \"your-username\", {\n       proxy (username) {\n         return fetch(`https://your-proxy.com/github?user=${username}`)\n       }\n    }).then(r =\u003e r.text())\n\u003c/script\u003e\n```\n\n\n[Here](https://bloggify.github.io/github-calendar/example/) you can see this example in action.\n\n\n\n\n\n\n\n\n## :question: Get Help\n\nThere are few ways to get help:\n\n\n\n 1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.\n 2. For bug reports and feature requests, open issues. :bug:\n\n\n\n\n\n\n\n## :memo: Documentation\n\n\n### `GitHubCalendar(container, username, options)`\nBrings the contributions calendar from GitHub (provided username) into your page.\n\n#### Params\n\n- **String|HTMLElement** `container`: The calendar container (query selector or the element itself).\n- **String** `username`: The GitHub username.\n- **Object** `options`: An object containing the following fields:\n   - `summary_text` (String): The text that appears under the calendar (defaults to: `\"Summary of\n     pull requests, issues opened, and commits made by \u003cusername\u003e\"`).\n   - `proxy` (Function): A function that receives as argument the username (string) and should return a promise resolving the HTML content of the contributions page.\n     The default is using @Bloggify's APIs.\n   - `global_stats` (Boolean): If `false`, the global stats (total, longest and current streaks) will not be calculated and displayed. By default this is enabled.\n   - `responsive` (Boolean): If `true`, the graph is changed to scale with the container. Custom CSS should be applied to the element to scale it appropriately. By default this is disabled.\n   - `tooltips` (Boolean): If `true`, tooltips will be shown when hovered over calendar days. By default this is disabled.\n   - `cache` (Number) The cache time in seconds.\n\n#### Return\n- **Promise** A promise returned by the `fetch()` call.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n## :yum: How to contribute\nHave an idea? Found a bug? See [how to contribute][contributing].\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n## :dizzy: Where is this library used?\nIf you are using this library in one of your projects, add it in this list. :sparkles:\n\n - `@axetroy/react-github-calendar`\n - `@dotnetthailand/gatsby-theme-minimal-portfolio`\n - `@jiratki/gatsby-theme-minimal-portfolio`\n - `@pengliheng/github-report`\n - `@philipwhiuk/react-github-calendar`\n - `github-alike-calendar`\n - `github-calendar-element`\n - `github-calendar-web-component`\n - `github-contributions-react`\n - `react-ts-github-calendar`\n\n\n\n\n\n\n\n\n\n\n\n## :scroll: License\n\n[MIT][license] © [Bloggify][website]\n\n\n\n\n\n\n[license]: /LICENSE\n[website]: https://bloggify.org\n[contributing]: /CONTRIBUTING.md\n[docs]: /DOCUMENTATION.md\n","funding_links":["https://github.com/sponsors/ionicabizau","https://patreon.com/ionicabizau","https://opencollective.com/ionicabizau","https://www.buymeacoffee.com/h96wwchmy"],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBloggify%2Fgithub-calendar","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FBloggify%2Fgithub-calendar","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBloggify%2Fgithub-calendar/lists"}