Get dynamically generated GitHub stats on your readmes!
View Demo · Report Bug · Request Feature
Loved the project? Please consider donating to help it improve!
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
To hide any specific stats, you can pass a query parameter ?hide= with comma separated values.
Options:
&hide=stars,commits,prs,issues,contribs
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
To enable icons, you can pass show_icons=true in the query param, like so:
With inbuilt themes you can customize the look of the card without doing any manual customization.
Use ?theme=THEME_NAME parameter like so :-
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
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 | CSV | hides the items specified | undefined | N/A | undefined |
| 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' |
| count_private | boolean | counts private contributions too if enabled | false | N/A | N/A |
| layout | string | choose a layout option | N/A | N/A | "default" |
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 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.
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)Use show_owner variable to include the repo's owner username
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
Copy-paste this code into your readme and change the links.
Endpoint: api/top-langs?username=anuraghazra
[](https://github.com/anuraghazra/github-readme-stats)You can use ?hide=language1,language2 parameter to hide individual languages.
[](https://github.com/anuraghazra/github-readme-stats)You can use the &layout=compact option to change the card design.
[](https://github.com/anuraghazra/github-readme-stats)- Compact layout
- Default
- Hiding specific stats
- Showing icons
- Themes
Choose from any of the default themes
- Customizing stats card
- Customizing repo card
- Top languages
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>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
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!
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 welcomed! <3
Made with ❤️ and JavaScript.