Miroslav Vidović

Miroslav Vidović

IT Engineer, Software Developer, Linux Enthusiast

github-calendar.js

PayPal AMA Version Downloads Get help on Codementor

Embed your GitHub contributions calendar anywhere.

Everybodywell, haters gonna hate 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. :tada:

:cloud: Installation

Check out the dist directory to download the needed files and include them on your page.

If you’re using this module in a CommonJS environment, you can install it from npm and require it:

$ npm i --save github-calendar
<!-- Prepare a container for your calendar. -->
<script
  src="https://cdn.rawgit.com/IonicaBizau/github-calendar/gh-pages/dist/github-calendar.min.js"
</script>

<!-- Optionally, include the theme (if you don't want to struggle to write the CSS) -->
<link
  rel="stylesheet"
  href="https://cdn.rawgit.com/IonicaBizau/github-calendar/gh-pages/dist/github-calendar.css"
/>

<!-- Prepare a container for your calendar. -->
<div class="calendar">
    <!-- Loading stuff -->
    Loading the data just for you.
</div>

<script>
    GitHubCalendar(".calendar", "your-username");
</script>

Here you can see this example in action.

:memo: Documentation

GitHubCalendar(container, username, options)

Brings the contributions calendar from GitHub (provided username) into your page.

Params

Return

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:cake: Thanks

:scroll: License

MIT © Ionică Bizău