Skip to content

🎨 Turn your GitHub activity into sleek stats and cool visuals

Notifications You must be signed in to change notification settings

Rahuletto/gitMyStat

Repository files navigation

gitmystat

gitMyStat!

Get Git my stat! 🎨 Turn your GitHub activity into sleek stats and cool visuals

Inspired by a great project github-readme-stats

Tip

Lazy to read alot just for readme? Me too! Thats why I made a Builder which generates the cards for your parameters. Give it a try!

Table of Contents


Parameters

All cards are built equally. Which means these apply to every card possible

Parameters Description Default
username The username to get the data from
theme The theme to apply on the cards dark

Customizations

Important

As url encoding messes up the # tag character, we wanted you to provide a hexadecimal code instead.

What's that?!

Nothing actually. instead of # we use 0x.

For example

#000000 is the same as 0x000000 > #075fff is the same as 0x075fff

Parameters Description
color The hexadecimal color of the text color
accent The hexadecimal color of the accent color
background The hexadecimal color of the background
border The hexadecimal color of the border
tip The hexadecimal color of the tertiary (tips) color
radius The radius of the border
padding The padding of the border
  • Totally decked out example
![image](https://gitmystat.vercel.app/recent?username=rahuletto&color=0xaeaeae&accent=0x075fff&background=0x000000&border=0x075fff&tip=0x075fff&radius=12&padding=24)

image

Tip

Adding theme={theme} in the url would change the theme of any card

For example

  • https://gitmystat.vercel.app/recent?username=rahuletto&theme=gold

recent theme


Cards

Warning

For wakatime, We are using WakaTime api, which only displays for profiles that are public. Make sure the Display code time publicly and Display languages, editors, os, categories publicly are enabled.


Themes

Visit the themes page!

You like a theme, but you just don't like that particular color?

It's alright! the parameters can override particular colors of the theme while keeping the other colors the same from the theme.

Extend it.

These themes are not hard coded. You can add your own! You have a great color palette? PLEASE do a pull request on our repo and make it a reality.

Note

If you are making a theme, please make a light mode version of it too. This is not mandatory to do, but it's a good thing to have more flavors.

How?

  • Go to /themes/index.ts
themename: {
    color: '#hex',
    accent: '#hex',
    background: '#hex',
    border: '#hex',
    tip: '#hex',
    radius: 24,
    padding: 24,
  },
  • Change the themename to the name you prefer
  • Change the color hex codes of the things, localhost would be great to test it
  • Push it, Do a pull request.

It's that simple.

About

🎨 Turn your GitHub activity into sleek stats and cool visuals

Topics

Resources

Stars

Watchers

Forks

Languages