GitHub Readme Stats

Get dynamically generated GitHub stats on your READMEs!

View Demo · Report Bug · Request Feature · FAQ · Ask Question

Français · 简体中文 · Español · Deutsch · 日本語 · Português Brasileiro · Italiano · 한국어 · Nederlands · नेपाली · Türkçe

Please note that documentation translations may be outdated, try to use english documentation if possible.

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

` element in combination with the `prefers-color-scheme` media feature. ```html ```

:eyes: Show example

### Customization You can customize the appearance of your `Stats Card` or `Repo Card` however you wish with URL parameters. #### Common Options * `title_color` - Card's title color *(hex color)*. Default: `2f80ed`. * `text_color` - Body text color *(hex color)*. Default: `434d58`. * `icon_color` - Icons color if available *(hex color)*. Default: `4c71f2`. * `border_color` - Card's border color *(hex color)*. Default: `e4e2e2` (Does not apply when `hide_border` is enabled). * `bg_color` - Card's background color *(hex color)* **or** a gradient in the form of *angle,start,end*. Default: `fffefe` * `hide_border` - Hides the card's border *(boolean)*. Default: `false` * `theme` - Name of the theme, choose from [all available themes](./themes/README.md). Default: `default` theme. * `cache_seconds` - Sets the cache header manually *(min: 14400, max: 86400)*. Default: `14400 seconds (4 hours)`. * `locale` - Sets the language in the card *(e.g. cn, de, es, etc.)*. Default: `en`. * `border_radius` - Corner rounding on the card. Default: `4.5`. > [!WARNING]\ > We use caching to decrease the load on our servers (see ). Our cards have a default cache of 4 hours (14400 seconds). Also, note that the cache is clamped to a minimum of 4 hours and a maximum of 24 hours. ##### Gradient in bg\_color You can provide multiple comma-separated values in the bg\_color option to render a gradient with the following format: &bg_color=DEG,COLOR1,COLOR2,COLOR3...COLOR10 #### Stats Card Exclusive Options * `hide` - Hides the [specified items](#hiding-individual-stats) from stats *(Comma-separated values)*. Default: `[] (blank array)`. * `hide_title` - *(boolean)*. Default: `false`. * `card_width` - Sets the card's width manually *(number)*. Default: `500px (approx.)`. * `hide_rank` - *(boolean)* hides the rank and automatically resizes the card width. Default: `false`. * `rank_icon` - Shows alternative rank icon (i.e. `github`, `percentile` or `default`). Default: `default`. * `show_icons` - *(boolean)*. Default: `false`. * `include_all_commits` - Counts total commits instead of just the current year commits *(boolean)*. Default: `false`. * `line_height` - Sets the line height between text *(number)*. Default: `25`. * `exclude_repo` - Excludes stars from specified repositories *(Comma-separated values)*. Default: `[] (blank array)`. * `custom_title` - Sets a custom title for the card. Default: ` GitHub Stats`. * `text_bold` - Uses bold text *(boolean)*. Default: `true`. * `disable_animations` - Disables all animations in the card *(boolean)*. Default: `false`. * `ring_color` - Color of the rank circle *(hex color)*. Defaults to the theme ring color if it exists and otherwise the title color. * `number_format` - Switches between two available formats for displaying the card values `short` (i.e. `6.6k`) and `long` (i.e. `6626`). Default: `short`. * `show` - Shows [additional items](#showing-additional-individual-stats) on stats card (i.e. `reviews`, `discussions_started` or `discussions_answered`) *(Comma-separated values)*. Default: `[] (blank array)`. > [!NOTE]\ > When hide\_rank=`true`, the minimum card width is 270 px + the title length and padding. #### Repo Card Exclusive Options * `show_owner` - Shows the repo's owner name *(boolean)*. Default: `false`. #### Language Card Exclusive Options * `hide` - Hides the languages specified from the card *(Comma-separated values)*. Default: `[] (blank array)`. * `hide_title` - *(boolean)*. Default: `false`. * `layout` - Switches between five available layouts `normal` & `compact` & `donut` & `donut-vertical` & `pie`. Default: `normal`. * `card_width` - Sets the card's width manually *(number)*. Default `300`. * `langs_count` - Shows more languages on the card, between 1-20 *(number)*. Default: `5` for `normal` and `donut`, `6` for other layouts. * `exclude_repo` - Excludes specified repositories *(Comma-separated values)*. Default: `[] (blank array)`. * `custom_title` - Sets a custom title for the card *(string)*. Default `Most Used Languages`. * `disable_animations` - Disables all animations in the card *(boolean)*. Default: `false`. * `hide_progress` - Uses the compact layout option, hides percentages, and removes the bars. Default: `false`. * `size_weight` - Configures language stats algorithm *(number)* (see [Language stats algorithm](#Language-stats-algorithm)), defaults to 1. * `count_weight` - Configures language stats algorithm *(number)* (see [Language stats algorithm](#Language-stats-algorithm)), defaults to 0. > [!WARNING]\ > Language names should be URI-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding) > (i.e: `c++` should become `c%2B%2B`, `jupyter notebook` should become `jupyter%20notebook`, etc.) You can use > [urlencoder.org](https://www.urlencoder.org/) to help you do this automatically. #### Wakatime Card Exclusive Options * `hide` - Hides the languages specified from the card *(Comma-separated values)*. Default: `[] (blank array)`. * `hide_title` - *(boolean)*. Default `false`. * `line_height` - Sets the line height between text *(number)*. Default `25`. * `hide_progress` - Hides the progress bar and percentage *(boolean)*. Default `false`. * `custom_title` - Sets a custom title for the card *(string)*. Default `Wakatime Stats`. * `layout` - Switches between two available layouts `default` & `compact`. Default `default`. * `langs_count` - Limits the number of languages on the card, defaults to all reported languages *(number)*. * `api_domain` - Sets a custom API domain for the card, e.g. to use services like [Hakatime](https://github.com/mujx/hakatime) or [Wakapi](https://github.com/muety/wakapi) *(string)*. Default `Waka API`. *** # 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` ```md [](https://github.com/anuraghazra/github-readme-stats) ``` ### Demo  Use [show\_owner](#repo-card-exclusive-options) query option to include the repo's owner username  # Top Languages Card The top languages card shows a GitHub user's most frequently used languages. > [!WARNING]\ > By default, the language card shows language results only from public repositories. To include languages used in private repositories, you should [deploy your own instance](#deploy-on-your-own) using your own GitHub API token. > [!NOTE]\ > Top Languages does not indicate the user's skill level or anything like that; it's a GitHub metric to determine which languages have the most code on GitHub. It is a new feature of github-readme-stats. > [!WARNING]\ > This card shows languages usage only inside your own non-forked repositories, not depending from who is the author of the commits. It does not include your contributions into another users/organizations repositories. Currently there are no way to get this data from GitHub API. If you want this behavior to be improved you can support [this feature request](https://github.com/orgs/community/discussions/18230) created by [@rickstaa](https://github.com/rickstaa) inside GitHub Community. ### Usage Copy-paste this code into your readme and change the links. Endpoint: `api/top-langs?username=anuraghazra` ```md [](https://github.com/anuraghazra/github-readme-stats) ``` ### Language stats algorithm We use the following algorithm to calculate the languages percentages on the language card: ```js ranking_index = (byte_count ^ size_weight) * (repo_count ^ count_weight) ``` By default, only the byte count is used for determining the languages percentages shown on the language card (i.e. `size_weight=1` and `count_weight=0`). You can, however, use the `&size_weight=` and `&count_weight=` options to weight the language usage calculation. The values must be positive real numbers. [More details about the algorithm can be found here](https://github.com/anuraghazra/github-readme-stats/issues/1600#issuecomment-1046056305). * `&size_weight=1&count_weight=0` - *(default)* Orders by byte count. * `&size_weight=0.5&count_weight=0.5` - *(recommended)* Uses both byte and repo count for ranking * `&size_weight=0&count_weight=1` - Orders by repo count ```md  ``` ### Exclude individual repositories You can use the `&exclude_repo=repo1,repo2` parameter to exclude individual repositories. ```md  ``` ### Hide individual languages You can use `&hide=language1,language2` parameter to hide individual languages. ```md  ``` ### 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. ```md  ``` ### Compact Language Card Layout You can use the `&layout=compact` option to change the card design. ```md  ``` ### Donut Chart Language Card Layout You can use the `&layout=donut` option to change the card design. ```md [](https://github.com/anuraghazra/github-readme-stats) ``` ### Donut Vertical Chart Language Card Layout You can use the `&layout=donut-vertical` option to change the card design. ```md [](https://github.com/anuraghazra/github-readme-stats) ``` ### Pie Chart Language Card Layout You can use the `&layout=pie` option to change the card design. ```md [](https://github.com/anuraghazra/github-readme-stats) ``` ### Hide Progress Bars You can use the `&hide_progress=true` option to hide the percentages and the progress bars (layout will be automatically set to `compact`). ```md  ``` ### Demo  * Compact layout  * Donut Chart layout [](https://github.com/anuraghazra/github-readme-stats) * Donut Vertical Chart layout [](https://github.com/anuraghazra/github-readme-stats) * Pie Chart layout [](https://github.com/anuraghazra/github-readme-stats) * Hidden progress bars  # Wakatime Stats Card > [!WARNING]\ > Please be aware that we currently only show data from Wakatime profiles that are public. You therefore have to make sure that **BOTH** `Display code time publicly` and `Display languages, editors, os, categories publicly` are enabled. Change the `?username=` value to your [Wakatime](https://wakatime.com) username. ```md [](https://github.com/anuraghazra/github-readme-stats) ``` ### Demo   * Compact layout  *** # All Demos * Default  * Hiding specific stats  * Showing additional stats  * Showing icons  * Shows Github logo instead rank level  * Shows user rank percentile instead of rank level  * Customize Border Color  * Include All Commits  * Themes Choose from any of the [default themes](#themes)  * Gradient  * Customizing stats card  * Setting card locale  * Customizing repo card  * Top languages  * WakaTime card  *** ## Quick Tip (Align The Cards) By default, GitHub does not lay out the cards side by side. To do that, you can use this approach: ```html ``` ```html ```

:eyes: Show example

***

# Deploy on your own ## On Vercel ### :film\_projector: [Check Out Step By Step Video Tutorial By @codeSTACKr](https://youtu.be/n6d4KHSKqGk?t=107) 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 do not have to worry about anything. Click on the deploy button to get started! > [!NOTE]\ > Since [#58](https://github.com/anuraghazra/github-readme-stats/pull/58), we should be able to handle more than 5k requests and have fewer issues with downtime :grin:. > [!NOTE]\ > If you are on the [Pro (i.e. paid)](https://vercel.com/pricing) Vercel plan, the [maxDuration](https://vercel.com/docs/concepts/projects/project-configuration#value-definition) value found in the [Vercel.json](https://github.com/anuraghazra/github-readme-stats/blob/master/vercel.json) can be increased when your Vercel instance frequently times out during the card request. You are advised to keep this value lower than `30` seconds to prevent high memory usage. [](https://vercel.com/import/project?template=https://github.com/anuraghazra/github-readme-stats)

:hammer_and_wrench: Step-by-step guide on setting up your own Vercel instance

1. Go to [vercel.com](https://vercel.com/). 2. Click on `Log in`.  3. Sign in with GitHub by pressing `Continue with GitHub`.  4. Sign in to GitHub and allow access to all repositories if prompted. 5. Fork this repo. 6. Go back to your [Vercel dashboard](https://vercel.com/dashboard). 7. To import a project, click the `Add New...` button and select the `Project` option.  8. Click the `Continue with GitHub` button, search for the required Git Repository and import it by clicking the `Import` button. Alternatively, you can import a Third-Party Git Repository using the `Import Third-Party Git Repository ->` link at the bottom of the page.  9. Create a personal access token (PAT) [here](https://github.com/settings/tokens/new) and enable the `repo` and `user` permissions (this allows access to see private repo and user stats). 10. Add the PAT as an environment variable named `PAT_1` (as shown).  11. Click deploy, and you're good to go. See your domains to use the API!

## On other platforms > [!WARNING]\ > This way of using GRS is not officially supported and was added to cater to some particular use cases where Vercel could not be used (e.g. [#2341](https://github.com/anuraghazra/github-readme-stats/discussions/2341)). The support for this method, therefore, is limited.

:hammer_and_wrench: Step-by-step guide for deploying on other platforms

1. Fork or clone this repo as per your needs 2. Add `express` to the dependencies section of `package.json` 3. Run `npm i` if needed (initial setup) 4. Run `node express.js` to start the server, or set the entry point to `express.js` in `package.json` if you're deploying on a managed service 5. You're done 🎉

## Disable rate limit protections Github Readme Stats contains several Vercel environment variables that can be used to remove the rate limit protections: * `CACHE_SECONDS`: This environment variable takes precedence over our cache minimum and maximum values and can circumvent these values for self Hosted Vercel instances. See [the Vercel documentation](https://vercel.com/docs/concepts/projects/environment-variables) on adding these environment variables to your Vercel instance. ## Keep your fork up to date You can keep your fork, and thus your private Vercel instance up to date with the upstream using GitHub's [Sync Fork button](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork). You can also use the [pull](https://github.com/wei/pull) package created by [@wei](https://github.com/wei) to automate this process. # :sparkling\_heart: Support the project I open-source almost everything I can and 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 are happy with it or just want to encourage me to continue creating stuff, there are a 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 :rocket: * [](https://www.paypal.me/anuraghazra) - You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea: Thanks! :heart: *** [](https://vercel.com?utm_source=github_readme_stats_team\&utm_campaign=oss) Contributions are welcome! <3 Made with :heart: and JavaScript.