Skip to content

stemount/github-readme-stats

 
 

Repository files navigation

Github Readme Stats

GitHub Readme Stats

Get dynamically generated GitHub stats on your readmes!

Tests Passing Issues GitHub pull requests

View Demo · Report Bug · Request Feature

简体中文 · Español

Loved the project? Please consider donating to help it improve!

Features

GitHub Stats Card

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

Change the ?username= value to your GitHub'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 user's 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","commits","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)

Themes

With inbuilt themes you can customize the look of the card without doing any manual customization.

Use ?theme=THEME_NAME parameter like so :-

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

All inbuilt themes :-

dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula

Github Readme Stat Themes

You can look at a preview for all available themes or checkout the theme config file & you can also contribute new themes if you like :D

Customization

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

Customization Options:

Option type description Stats Card (default) Repo Card (default) Top Lang Card (default)
title_color hex color title color 2f80ed 2f80ed 2f80ed
text_color hex color body color 333 333 333
icon_color hex color icon color 4c71f2 586069 586069
bg_color hex color card bg color FFFEFE FFFEFE FFFEFE
line_height number control the line-height between text 30 N/A N/A
hide_rank boolean hides the ranking false N/A N/A
hide_title boolean hides the stats title false N/A false
hide_border boolean hides the stats card border false N/A N/A
show_owner boolean shows owner name in repo card N/A false N/A
show_icons boolean shows icons false N/A N/A
theme string sets inbuilt theme 'default' 'default_repocard' 'default
cache_seconds number manually set custom cache control 1800 1800 '1800'
hide_langs_below number hide langs below certain threshold (lang card) N/A N/A undefined

Note on cache: Repo cards have default cache of 30mins (1800 seconds) if the fork count & star count is less than 1k otherwise it's 2hours (7200). Also note that cache is clamped to minimum of 30min and maximum of 24hours

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

Use show_owner variable to include the repo's owner username

ReadMe Card

Top Languages Card

Top languages card shows github user's top langauges which has been mostly used.

NOTE: Top languages does not indicate my skill level or something like that, it's a github metric of which languages i have the most code on github, it's a new feature of github-readme-stats

Usage

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

Endpoint: api/top-langs?username=anuraghazra

[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)

Hide languages below certain threshold

You can use ?hide_langs_below=NUMBER parameter to hide languages below a specified threshold percentage.

[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&hide_langs_below=1)](https://github.com/anuraghazra/github-readme-stats)

Demo

Top Langs


All Demos

  • Default

Anurag's github stats

  • Hiding specific stats

Anurag's github stats

  • Showing icons

Anurag's github stats

  • Themes

Choose from any of the default themes

Anurag's github stats

  • Customizing stats card

Anurag's github stats

  • Customizing repo card

Customized Card

  • Top languages

Top Langs


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 the 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. If you host it on your own Vercel server, then you don't have to worry about anything. Click on the deploy button to get started!

NOTE: Since #58 we should be able to handle more than 5k requests and have no issues with downtime :D

Deploy to Vercel

Guide on setting up Vercel
  1. Go to vercel.com
  2. Click on Log in
  3. Sign in with GitHub by pressing Continue with GitHub
  4. Sign into GitHub and allow access to all repositories, if prompted
  5. Fork this repo
  6. Go back to your Vercel dashboard
  7. Select Import Project
  8. Select Import Git Repository
  9. Select root and keep everything as is, just add your environment variable named PAT_1 (as shown), which will contain a personal access token (PAT), which you can easily create here (leave everything as is, just name it something, it can be anything you want)
  10. Click deploy, and you're good to go. See your domains to use the API!

💖 Support the project

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can use this service for free.

However, if you are using this project and happy with it or just want to encourage me to continue creating stuff, there are few ways you can do it :-

  • Giving proper credit when you use github-readme-stats on your readme, linking back to it :D
  • Starring and sharing the project 🚀
  • paypal.me/anuraghazra - You can make one-time donations via PayPal. I'll probably buy a coffee tea. 🍵

Thanks! ❤️


Contributions are welcomed! <3

Made with ❤️ and JavaScript.

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%