@christianesk/github-calendar
TypeScript icon, indicating that this package has built-in type declarations

2.0.1 • Public • Published

Github's Contribution Calendar (NPM)
by StkngEsk

npm Version GitHub License

This project returns a calendar of contributions de Github in a <div>...</div> format depending on the user and year chosen.

Content

Installation

npm i @christianesk/github-calendar


TS Example

import { getGithubCalendar } from "@christianesk/github-calendar";

const getCalendar = async () => {
   
    return await getGithubCalendar("christianesk", "2020");
} 

/*Returns an Object with these parameters:
    //Example
    { 
        textContributions: "256 contributions in 2020"      
        calendar: "<div>...</div>",
    }
*/

JS Example

const getGithubCalendar = require("@christianesk/github-calendar");

const getCalendar = async () => {
   
    return await getGithubCalendar("christianesk", "2020");
} 

/*Returns an Object with these parameters:
    //Example
    { 
        textContributions: "256 contributions in 2020"      
        calendar: "<div>...</div>",
    }
*/

Implementation examples

Using cloudflare workers

Fetch cloudflare workers with Angular

Styles CSS to github calendar

Using Framework Astro

Authors


License

MIT © Stkngesk

Package Sidebar

Install

npm i @christianesk/github-calendar

Weekly Downloads

0

Version

2.0.1

License

MIT

Unpacked Size

11.6 kB

Total Files

9

Last publish

Collaborators

  • christianesk