Skip to content

Dynamically generated stats for your github readmes

License

Notifications You must be signed in to change notification settings

Luismi74/github-readme-stats

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

63 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Github Readme Stats

Get dynamically generated GitHub stats on your readmes!

Tests Passing Issues GitHub pull requests

View Demo · Report Bug · Request Feature

Features

Github Stats Card

Copy paste this into your markdown content, and that's it. Simple!

change the ?username= value to your GitHubs's username

[![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)

Note: Ranks are calculated based on users stats, see src/calculateRank.js

Hiding individual stats

To hide any specific stats, you can pass a query parameter ?hide= with an array of items, you wanna hide.

Options: &hide=["stars","prs","issues","contribs"]

![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=["contribs","prs"])

Showing icons

To enable icons, you can pass show_icons=true in the query param like so

![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true)

Other options:

  • &hide_border=true hide the border box if you don't like it :D.
  • &line_height=30 control the line-height between text.
  • &hide_rank=true hides the ranking

Customization

You can customize the appearance of your Stats Card or Repo Card however you want with url params.

Customization Options:

Option type Stats Card (default) Repo Card (default)
title_color hex color #2f80ed #2f80ed
text_color hex color #333 #333
icon_color hex color #4c71f2 #586069
bg_color hex color rgba(255, 255, 255, 0) rgba(255, 255, 255, 0)
  • You can also customize the cards to be compatible with dark mode
![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&title_color=fff&icon_color=79ff97&text_color=9f9f9f&bg_color=151515)

Demo

  • Default

Anurag's github stats

  • Hiding specific stats

Anurag's github stats

  • Showing icons

Anurag's github stats

  • Customizing stats card

Anurag's github stats

  • Customizing repo card

Customized Card

Github Extra Pins

Github extra pins allow you to pin more than 6 repositories in your profile using a GitHub readme profile.

Yey! you are no longer limited to 6 pinned repositories.

Usage

Copy-paste this code into your readme and change the links.

Endpoint: api/pin?username=anuraghazra&repo=github-readme-stats

[![ReadMe Card](https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats)](https://github.com/anuraghazra/github-readme-stats)

Demo

ReadMe Card

Quick Tip (Align The Repo Cards)

You usually won't be able to layout the images side by side to do that you can use this approach

<a href="https://github.com/anuraghazra/github-readme-stats">
  <img align="left" src="https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats" />
</a>
<a href="https://github.com/anuraghazra/convoychat">
  <img align="left" src="https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=convoychat" />
</a>

Deploy on your own vercel instance

Since Github API only allows 5k requests per hour it is possible that my https://github-readme-stats.vercel.app/api could hit the rate limiter thats why if you want to host it on your own vercel server then you don't have to worry about anything. click on the deploy button to get started

Deploy to Vercel

Make sure to add your own GITHUB_TOKEN in Environment Variables
Github Docs: Creating a github personal token

Contributions are welcomed! <3

Made with ❤️ and javascript.

About

Dynamically generated stats for your github readmes

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%