Get dynamically generated GitHub stats on your READMEs!
View Demo · Report Bug · Request Feature · FAQ · Ask Question
Love the project? Please consider donating to help it improve!
> [!IMPORTANT]\
> We're a small team, and to prioritize, we rely on upvotes :+1:. We use the Top Issues dashboard for tracking community demand (see [#1935](https://github.com/anuraghazra/github-readme-stats/issues/1935)). Do not hesitate to upvote the issues and pull requests you are interested in. We will work on the most upvoted first.
# GitHub Stats Card
Copy and paste this into your markdown, and that's it. Simple!
Change the `?username=` value to your GitHub username.
```md
[](https://github.com/anuraghazra/github-readme-stats)
```
> [!WARNING]\
> By default, the stats card only shows statistics like stars, commits, and pull requests from public repositories. To show private statistics on the stats card, you should [deploy your own instance](#deploy-on-your-own) using your own GitHub API token.
> [!NOTE]\
> Available ranks are S (top 1%), A+ (12.5%), A (25%), A- (37.5%), B+ (50%), B (62.5%), B- (75%), C+ (87.5%) and C (everyone). This ranking scheme is based on the [Japanese academic grading](https://wikipedia.org/wiki/Academic_grading_in_Japan) system. The global percentile is calculated as a weighted sum of percentiles for each statistic (number of commits, pull requests, reviews, issues, stars, and followers), based on the cumulative distribution function of the [exponential](https://wikipedia.org/wiki/exponential_distribution) and the [log-normal](https://wikipedia.org/wiki/Log-normal_distribution) distributions. The implementation can be investigated at [src/calculateRank.js](https://github.com/anuraghazra/github-readme-stats/blob/master/src/calculateRank.js). The circle around the rank shows 100 minus the global percentile.
### Hiding individual stats
You can pass a query parameter `&hide=` to hide any specific stats with comma-separated values.
> Options: `&hide=stars,commits,prs,issues,contribs`
```md
```
### Showing additional individual stats
You can pass a query parameter `&show=` to show any specific additional stats with comma-separated values.
> Options: `&show=reviews,discussions_started,discussions_answered,prs_merged,prs_merged_percentage`
```md
```
### Showing icons
To enable icons, you can pass `&show_icons=true` in the query param, like so:
```md
```
### Themes
With inbuilt themes, you can customize the look of the card without doing any [manual customization](#customization).
Use `&theme=THEME_NAME` parameter like so :
```md
```
#### All inbuilt themes
GitHub Readme Stats comes with several built-in themes (e.g. `dark`, `radical`, `merko`, `gruvbox`, `tokyonight`, `onedark`, `cobalt`, `synthwave`, `highcontrast`, `dracula`).
You can look at a preview for [all available themes](themes/README.md) or checkout the [theme config file](themes/index.js). Please note that we paused the addition of new themes to decrease maintenance efforts; all pull requests related to new themes will be closed.
#### Responsive Card Theme
[](https://github.com/anuraghazra/github-readme-stats#responsive-card-theme#gh-dark-mode-only)
[](https://github.com/anuraghazra/github-readme-stats#responsive-card-theme#gh-light-mode-only)
Since GitHub will re-upload the cards and serve them from their [CDN](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/about-anonymized-urls), we can not infer the browser/GitHub theme on the server side. There are, however, four methods you can use to create dynamics themes on the client side.
##### Use the transparent theme
We have included a `transparent` theme that has a transparent background. This theme is optimized to look good on GitHub's dark and light default themes. You can enable this theme using the `&theme=transparent` parameter like so:
```md
```
| | Code | Locale | | --- | --- | | `cn` | Chinese | | `zh-tw` | Chinese (Taiwan) | | `ar` | Arabic | | `cs` | Czech | | `de` | German | | `en` | English | | `bn` | Bengali | | `es` | Spanish | | `fr` | French | | `hu` | Hungarian | | | Code | Locale | | --- | --- | | `it` | Italian | | `ja` | Japanese | | `kr` | Korean | | `nl` | Dutch | | `pt-pt` | Portuguese (Portugal) | | `pt-br` | Portuguese (Brazil) | | `np` | Nepali | | `el` | Greek | | `ru` | Russian | | `uk-ua` | Ukrainian | | | Code | Locale | | --- | --- | | `id` | Indonesian | | `ml` | Malayalam | | `my` | Burmese | | `sk` | Slovak | | `tr` | Turkish | | `pl` | Polish | | `uz` | Uzbek | | `vi` | Vietnamese | | `se` | Swedish | | `az` | Azerbaijani | |