htmlgithubgithub-api

Embed Github contributions graph in website

Is there a way to embed the Github contributions graph in HTML5?

enter image description here

Solution

  • I wrote a JavaScript library to do that: github-calendar.

    Here is an example how to use it:

    <!-- Include the library. -->
<script
  src="https://unpkg.com/github-calendar@latest/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://unpkg.com/github-calendar@latest/dist/github-calendar-responsive.css"
/>

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

<script>
    GitHubCalendar(".calendar", "your-username");
    // or enable responsive functionality
    GitHubCalendar(".calendar", "your-username", { responsive: true });
</script>

    Here you can see it in action:

    Basically, since we need cross domain requests we need a proxy. It makes a request to GitHub profile page (github.com/<user>) and then brings back the needed stuff from there.

    For more information, check out the documentation on GitHub.