GitHub Readme Stats
Get dynamically generated GitHub stats on your READMEs!
Love the project? Please consider donating to support the original creator!
[!CAUTION]
This repository is no longer maintained. Please use the successor project GitHub Stats Extended instead! GitHub Stats Extended is an actively maintained fork of this repository with additional features and improved stability. Alternatively you can also use GitHub Readme Stats Action.
Click here to view the outdated documentation. Kept for reference only.
View Demo
·
Report Bug
·
Request Feature
·
FAQ
·
Ask Question
Table of contents (Click to show)
- [GitHub Stats Card](#github-stats-card)
- [Hiding individual stats](#hiding-individual-stats)
- [Showing additional individual stats](#showing-additional-individual-stats)
- [Showing icons](#showing-icons)
- [Showing commits count for specified year](#showing-commits-count-for-specified-year)
- [Themes](#themes)
- [Customization](#customization)
- [GitHub Extra Pins](#github-extra-pins)
- [Usage](#usage)
- [Options](#options)
- [Demo](#demo)
- [GitHub Gist Pins](#github-gist-pins)
- [Usage](#usage-1)
- [Options](#options-1)
- [Demo](#demo-1)
- [Top Languages Card](#top-languages-card)
- [Usage](#usage-2)
- [Options](#options-2)
- [Language stats algorithm](#language-stats-algorithm)
- [Exclude individual repositories](#exclude-individual-repositories)
- [Hide individual languages](#hide-individual-languages)
- [Show more languages](#show-more-languages)
- [Compact Language Card Layout](#compact-language-card-layout)
- [Donut Chart Language Card Layout](#donut-chart-language-card-layout)
- [Donut Vertical Chart Language Card Layout](#donut-vertical-chart-language-card-layout)
- [Pie Chart Language Card Layout](#pie-chart-language-card-layout)
- [Hide Progress Bars](#hide-progress-bars)
- [Change format of language's stats](#change-format-of-languages-stats)
- [Demo](#demo-2)
- [WakaTime Stats Card](#wakatime-stats-card)
- [Options](#options-3)
- [Demo](#demo-3)
- [All Demos](#all-demos)
- [Quick Tip (Align The Cards)](#quick-tip-align-the-cards)
- [Stats and top languages cards](#stats-and-top-languages-cards)
- [Pinning repositories](#pinning-repositories)
- [Deploy on your own](#deploy-on-your-own)
- [GitHub Actions (Recommended)](#github-actions-recommended)
- [Self-hosted (Vercel/Other) (Recommended)](#self-hosted-vercelother-recommended)
- [First step: get your Personal Access Token (PAT)](#first-step-get-your-personal-access-token-pat)
- [On Vercel](#on-vercel)
- [:film\_projector: Check Out Step By Step Video Tutorial By @codeSTACKr](#film_projector-check-out-step-by-step-video-tutorial-by-codestackr)
- [On other platforms](#on-other-platforms)
- [Available environment variables](#available-environment-variables)
- [Keep your fork up to date](#keep-your-fork-up-to-date)
- [:sparkling\_heart: Support the project](#sparkling_heart-support-the-project)
# Important Notices
|
⚠️Warning
The public Vercel instance at `https://github-readme-stats.vercel.app/api` is best-effort and can be unreliable due to rate limits and traffic spikes (see [#1471](https://github.com/anuraghazra/github-readme-stats/issues/1471)). We use caching to improve stability (see [common options](#common-options)), but for reliable cards we recommend [self-hosting](#deploy-on-your-own) (Vercel or other) or using the [GitHub Actions workflow](#github-actions-recommended) to generate cards in your [profile repository](https://docs.github.com/en/account-and-profile/how-tos/profile-customization/managing-your-profile-readme).
|
|
⚠️Warning
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.
[](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`

### 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`

### Showing icons
To enable icons, you can pass `&show_icons=true` in the query param, like so:

### Showing commits count for specified year
You can specify a year and fetch only the commits that were made in that year by passing `&commits_year=YYYY` to the parameter.

### 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 :

#### 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](https://github.com/anuraghazra/github-readme-stats/blob/HEAD/themes/README.md) or checkout the [theme config file](https://github.com/anuraghazra/github-readme-stats/blob/HEAD/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