| .github | ||
| api | ||
| docs | ||
| scripts | ||
| src | ||
| tests | ||
| themes | ||
| .gitattributes | ||
| .gitignore | ||
| .vercelignore | ||
| codecov.yml | ||
| CONTRIBUTING.md | ||
| jest.config.js | ||
| LICENSE | ||
| package.json | ||
| readme.md | ||
| vercel.json | ||
GitHub Readme Stats
Get dynamically generated GitHub stats on your readmes!
View Demo · Report Bug · Request Feature
Français · 简体中文 · Español · Deutsch · 日本語 · Português Brasileiro · Italiano · 한국어
Loved the project? Please consider donating to help it improve!
Features
- GitHub Stats Card
- GitHub Extra Pins
- Top Languages Card
- Wakatime Week Stats
- Themes
- Customization
- Deploy Yourself
GitHub Stats Card
Copy-paste this into your markdown content, and that's it. Simple!
Change the ?username= value to your GitHub's username.
[](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 comma-separated values.
Options:
&hide=stars,commits,prs,issues,contribs
Adding private contributions count to total commits count
You can add the count of all your private contributions to the total commits count by using the query parameter ?count_private=true.
Note: If you are deploying this project yourself, the private contributions will be counted by default otherwise you need to chose to share your private contribution counts.
Options:
&count_private=true
Showing icons
To enable icons, you can pass show_icons=true in the query param, like so:
Themes
With inbuilt themes, you can customize the look of the card without doing any manual customization.
Use ?theme=THEME_NAME parameter like so :-
All inbuilt themes :-
dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula
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.
Common Options:
title_color- Card's title color (hex color)text_color- Body text color (hex color)icon_color- Icons color if available (hex color)bg_color- Card's background color (hex color) or a gradient in the form of angle,start,endtheme- name of the theme, choose from all available themescache_seconds- set the cache header manually (min: 1800, max: 86400)
Gradient in bg_color
You can provide multiple comma-separated values in bg_color option to render a gradient, the format of the gradient is :-
&bg_color=DEG,COLOR1,COLOR2,COLOR3...COLOR10
Note on cache: Repo cards have a default cache of 4 hours (14400 seconds) if the fork count & star count is less than 1k, otherwise, it's 2 hours (7200 seconds). Also, note that the cache is clamped to a minimum of 2 hours and a maximum of 24 hours
Stats Card Exclusive Options:
hide- Hides the specified items from stats (Comma-separated values)hide_title- (boolean)hide_rank- (boolean)show_icons- (boolean)include_all_commits- Count total commits instead of just the current year commits (boolean)count_private- Count private commits (boolean)line_height- Sets the line-height between text (number)
Repo Card Exclusive Options:
show_owner- Show the owner name of the repo (boolean)
Language Card Exclusive Options:
hide- Hide the languages specified from the card (Comma-separated values)hide_title- (boolean)layout- Switch between two available layoutsdefault&compactcard_width- Set the card's width manually (number)langs_count- Show more languages on the card, between 1-10, defaults to 5 (number)
⚠️ Important:
Language names should be uri-escaped, as specified in Percent Encoding
(i.e:c++should becomec%2B%2B,jupyter notebookshould becomejupyter%20notebook, etc.)
Wakatime Card Exclusive Options:
hide_title- (boolean)hide_border- (boolean)line_height- Sets the line-height between text (number)hide_progress- Hides the progress bar and percentage (boolean)
GitHub Extra Pins
GitHub extra pins allow you to pin more than 6 repositories in your profile using a GitHub readme profile.
Yay! 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
[](https://github.com/anuraghazra/github-readme-stats)
Demo
Use show_owner variable to include the repo's owner username
Top Languages Card
The top languages card shows a GitHub user's top languages which have used the most.
NOTE: Top Languages does not indicate my skill level or anything like that, it's a GitHub metric of which languages 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
[](https://github.com/anuraghazra/github-readme-stats)
Hide individual languages
You can use ?hide=language1,language2 parameter to hide individual languages.
[](https://github.com/anuraghazra/github-readme-stats)
Show more languages
You can use the &langs_count= option to increase or decrease the number of languages shown on the card. Valid values are integers between 1 and 10 (inclusive), and the default is 5.
[](https://github.com/anuraghazra/github-readme-stats)
Compact Language Card Layout
You can use the &layout=compact option to change the card design.
[](https://github.com/anuraghazra/github-readme-stats)
Demo
- Compact layout
Wakatime Week Stats
Change the ?username= value to your Wakatime username.
[](https://github.com/anuraghazra/github-readme-stats)
Demo
All Demos
- Default
- Hiding specific stats
- Showing icons
- Include All Commits
- Themes
Choose from any of the default themes
- Gradient
- Customizing stats card
- Customizing repo card
- Top languages
- Wakatime 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="center" 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="center" src="https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=convoychat" />
</a>
Deploy on your own Vercel instance
Check Out Step By Step Video Tutorial By @codeSTACKr
Since the GitHub API only allows 5k requests per hour, my https://github-readme-stats.vercel.app/api could possibly 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
Guide on setting up Vercel 🔨
- Go to vercel.com
- Click on
Log in
- Sign in with GitHub by pressing
Continue with GitHub
- Sign into GitHub and allow access to all repositories, if prompted
- Fork this repo
- Go back to your Vercel dashboard
- Select
Import Project
- Select
Import Git Repository
- 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)
- 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 🚀
- You can make one-time donations via PayPal. I'll probably buy a coffeetea. 🍵
Thanks! ❤️
Contributions are welcome! <3
Made with ❤️ and JavaScript.