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 · 한국어

Loved the project? Please consider donating to help it improve! # Features - [GitHub Stats Card](#github-stats-card) - [GitHub Extra Pins](#github-extra-pins) - [Top Languages Card](#top-languages-card) - [Themes](#themes) - [Customization](#customization) - [Deploy Yourself](#deploy-on-your-own-vercel-instance) # GitHub Stats Card Copy paste this into your markdown content, and that's it. Simple! Change the `?username=` value to your GitHub's username. ```md [](https://github.com/anuraghazra/github-readme-stats) ``` _Note: Ranks are calculated based on user's stats, see [src/calculateRank.js](./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` ```md  ``` ### 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` ```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 :- 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) & **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,end_ - `theme` - name of the theme, choose from [all available themes](./themes/README.md) - `cache_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,COLRO2,COLOR3...COLOR10 ``` > Note on cache: Repo cards have default cache of 4hours (14400 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 2hours and maximum of 24hours #### Stats Card Exclusive Options: - `hide` - Hides the specified items from stats _(Comma seperated 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 seperated values)_ - `hide_title` - _(boolean)_ - `layout` - Switch between two available layouts `default` & `compact` - `card_width` - Set the card's width manually _(number)_ > :warning: **Important:** > 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.) --- # GitHub Extra Pins 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. ### 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 [](https://github.com/anuraghazra/github-readme-stats) Use [show_owner](#customization) variable to include the repo's owner username [](https://github.com/anuraghazra/github-readme-stats) # Top Languages Card Top languages card shows github user's top languages 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_ ### 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) ``` ### Hide individual languages You can use `?hide=language1,language2` parameter to hide individual languages. ```md [](https://github.com/anuraghazra/github-readme-stats) ``` ### Compact Language Card Layout You can use the `&layout=compact` option to change the card design. ```md [](https://github.com/anuraghazra/github-readme-stats) ``` ### Demo [](https://github.com/anuraghazra/github-readme-stats) - Compact layout [](https://github.com/anuraghazra/github-readme-stats) --- ### All Demos - Default  - Hiding specific stats  - Showing icons  - Include All Commits  - Themes Choose from any of the [default themes](#themes)  - Gradient  - Customizing stats card  - Customizing repo card  - Top languages [](https://github.com/anuraghazra/github-readme-stats) --- ### 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: ```md ``` ## Deploy on your own Vercel instance 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](https://github.com/anuraghazra/github-readme-stats/pull/58) we should be able to handle more than 5k requests and have no issues with downtime :D [](https://vercel.com/import/project?template=https://github.com/anuraghazra/github-readme-stats)