2020-07-13 17:26:59 +08:00
< p align = "center" >
2020-07-29 07:58:42 +08:00
< img width = "100px" src = "https://res.cloudinary.com/anuraghazra/image/upload/v1594908242/logo_ccswme.svg" align = "center" alt = "GitHub Readme Stats" / >
2020-07-15 05:08:52 +08:00
< h2 align = "center" > GitHub Readme Stats< / h2 >
2020-07-13 17:26:59 +08:00
< p align = "center" > Get dynamically generated GitHub stats on your readmes!< / p >
2020-07-16 16:32:15 +08:00
< / p >
2020-07-13 17:26:59 +08:00
< p align = "center" >
< a href = "https://github.com/anuraghazra/github-readme-stats/actions" >
< img alt = "Tests Passing" src = "https://github.com/anuraghazra/github-readme-stats/workflows/Test/badge.svg" / >
< / a >
2020-07-23 01:56:10 +08:00
< a href = "https://codecov.io/gh/anuraghazra/github-readme-stats" >
< img src = "https://codecov.io/gh/anuraghazra/github-readme-stats/branch/master/graph/badge.svg" / >
< / a >
2020-07-13 17:26:59 +08:00
< a href = "https://github.com/anuraghazra/github-readme-stats/issues" >
< img alt = "Issues" src = "https://img.shields.io/github/issues/anuraghazra/github-readme-stats?color=0088ff" / >
< / a >
< a href = "https://github.com/anuraghazra/github-readme-stats/pulls" >
< img alt = "GitHub pull requests" src = "https://img.shields.io/github/issues-pr/anuraghazra/github-readme-stats?color=0088ff" / >
< / a >
2020-07-29 15:21:55 +08:00
< br / >
< br / >
< a href = "https://a.paddle.com/v2/click/16413/119403?link=1227" >
< img src = "https://img.shields.io/badge/Supported%20by-VSCode%20Power%20User%20%E2%86%92-gray.svg?colorA=655BE1&colorB=4F44D6&style=for-the-badge" / >
< / a >
< a href = "https://a.paddle.com/v2/click/16413/119403?link=2345" >
< img src = "https://img.shields.io/badge/Supported%20by-Node%20Cli.com%20%E2%86%92-gray.svg?colorA=61c265&colorB=4CAF50&style=for-the-badge" / >
< / a >
2020-07-13 17:26:59 +08:00
< / p >
< p align = "center" >
< a href = "#demo" > View Demo< / a >
·
2020-07-24 20:45:20 +08:00
< a href = "https://github.com/anuraghazra/github-readme-stats/issues/new/choose" > Report Bug< / a >
2020-07-13 17:26:59 +08:00
·
2020-07-24 20:45:20 +08:00
< a href = "https://github.com/anuraghazra/github-readme-stats/issues/new/choose" > Request Feature< / a >
2020-07-13 17:26:59 +08:00
< / p >
2020-07-19 12:00:32 +08:00
< p align = "center" >
2020-08-14 23:42:27 +08:00
< a href = "/docs/readme_fr.md" > Français < / a >
·
2020-08-10 00:13:32 +08:00
< a href = "/docs/readme_cn.md" > 简体中文< / a >
2020-07-21 00:39:39 +08:00
·
2020-08-10 00:13:32 +08:00
< a href = "/docs/readme_es.md" > Español< / a >
2020-07-28 23:28:19 +08:00
·
2020-08-10 00:13:32 +08:00
< a href = "/docs/readme_de.md" > Deutsch< / a >
2020-07-28 23:31:52 +08:00
·
2020-08-10 00:13:32 +08:00
< a href = "/docs/readme_ja.md" > 日本語< / a >
2020-08-09 23:43:25 +08:00
·
2020-08-10 00:13:32 +08:00
< a href = "/docs/readme_pt-BR.md" > Português Brasileiro< / a >
2020-08-09 23:43:25 +08:00
·
2020-08-10 00:13:32 +08:00
< a href = "/docs/readme_kr.md" > 한국어< / a >
2020-07-19 12:00:32 +08:00
< / p >
2020-07-13 17:26:59 +08:00
< / p >
2020-07-16 16:32:15 +08:00
< p align = "center" > Loved the project? Please consider < a href = "https://www.paypal.me/anuraghazra" > donating< / a > to help it improve!
2020-07-09 18:38:21 +08:00
2020-07-10 01:26:57 +08:00
# Features
2020-07-15 05:08:52 +08:00
- [GitHub Stats Card ](#github-stats-card )
- [GitHub Extra Pins ](#github-extra-pins )
2020-07-21 21:23:24 +08:00
- [Top Languages Card ](#top-languages-card )
2020-07-19 23:04:41 +08:00
- [Themes ](#themes )
2020-07-12 15:46:30 +08:00
- [Customization ](#customization )
2020-07-11 17:03:29 +08:00
- [Deploy Yourself ](#deploy-on-your-own-vercel-instance )
2020-07-10 01:26:57 +08:00
2020-07-15 05:08:52 +08:00
# GitHub Stats Card
2020-07-09 18:38:21 +08:00
2020-07-10 18:45:03 +08:00
Copy paste this into your markdown content, and that's it. Simple!
2020-07-09 18:38:21 +08:00
2020-07-15 05:08:52 +08:00
Change the `?username=` value to your GitHub's username.
2020-07-09 18:38:21 +08:00
2020-07-10 18:49:52 +08:00
```md
[](https://github.com/anuraghazra/github-readme-stats)
```
2020-07-15 05:08:52 +08:00
_Note: Ranks are calculated based on user's stats, see [src/calculateRank.js ](./src/calculateRank.js )_
2020-07-13 22:20:43 +08:00
2020-07-10 18:45:03 +08:00
### Hiding individual stats
2020-07-09 20:20:15 +08:00
2020-07-28 15:00:28 +08:00
To hide any specific stats, you can pass a query parameter `?hide=` with comma separated values.
2020-07-09 20:20:15 +08:00
2020-07-23 23:31:23 +08:00
> Options: `&hide=stars,commits,prs,issues,contribs`
2020-07-09 20:20:15 +08:00
```md
2020-07-26 23:14:09 +08:00
2020-07-09 20:20:15 +08:00
```
2020-07-24 22:04:38 +08:00
### 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
```
2020-07-09 21:16:41 +08:00
### Showing icons
2020-07-15 05:08:52 +08:00
To enable icons, you can pass `show_icons=true` in the query param, like so:
2020-07-09 21:16:41 +08:00
```md
```
2020-07-19 23:04:41 +08:00
### 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
2020-07-29 07:58:42 +08:00
< img src = "https://res.cloudinary.com/anuraghazra/image/upload/v1595174536/grs-themes_l4ynja.png" alt = "GitHub Readme Stat Themes" width = "600px" / >
2020-07-20 00:05:57 +08:00
2020-07-20 23:40:23 +08:00
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
2020-07-19 23:04:41 +08:00
2020-07-12 15:46:30 +08:00
### Customization
2020-07-15 05:08:52 +08:00
You can customize the appearance of your `Stats Card` or `Repo Card` however you want with URL params.
2020-07-12 15:46:30 +08:00
2020-07-30 22:56:13 +08:00
#### 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)_
2020-08-05 20:06:50 +08:00
- `bg_color` - Card's background color _(hex color)_ **or** a gradient in the form of _angle,start,end_
2020-07-30 22:56:13 +08:00
- `theme` - name of the theme, choose from [all available themes ](./themes/README.md )
- `cache_seconds` - set the cache header manually _(min: 1800, max: 86400)_
2020-07-21 00:32:50 +08:00
2020-08-10 00:41:01 +08:00
##### Gradient in bg_color
2020-08-14 02:15:57 +08:00
You can provide multiple comma separated values in bg_color option to render a gradient, the format of the gradient is :-
2020-08-10 00:41:01 +08:00
```
& bg_color=DEG,COLOR1,COLRO2,COLOR3...COLOR10
```
2020-08-13 21:56:42 +08:00
> 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
2020-07-12 15:46:30 +08:00
2020-07-30 22:56:13 +08:00
#### Stats Card Exclusive Options:
2020-08-14 02:15:57 +08:00
- `hide` - Hides the specified items from stats _(Comma seperated values)_
2020-07-30 22:56:13 +08:00
- `hide_title` - _(boolean)_
- `hide_rank` - _(boolean)_
- `show_icons` - _(boolean)_
2020-07-31 16:16:27 +08:00
- `include_all_commits` - Count total commits instead of just the current year commits _(boolean)_
2020-07-30 22:56:13 +08:00
- `count_private` - Count private commits _(boolean)_
2020-07-31 15:29:25 +08:00
- `line_height` - Sets the line-height between text _(number)_
2020-07-30 22:56:13 +08:00
#### 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.)
---
2020-07-21 21:23:24 +08:00
# 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
2020-08-14 02:15:57 +08:00
Top languages card shows github user's top languages which has been mostly used.
2020-07-21 21:23:24 +08:00
_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)
```
2020-07-23 22:17:04 +08:00
### Hide individual languages
2020-07-21 21:23:24 +08:00
2020-07-23 23:31:23 +08:00
You can use `?hide=language1,language2` parameter to hide individual languages.
2020-07-21 21:23:24 +08:00
```md
2020-07-24 11:25:25 +08:00
[](https://github.com/anuraghazra/github-readme-stats)
2020-07-21 21:23:24 +08:00
```
2020-07-12 15:46:30 +08:00
2020-07-27 00:15:23 +08:00
### Compact Language Card Layout
You can use the `&layout=compact` option to change the card design.
```md
[](https://github.com/anuraghazra/github-readme-stats)
```
2020-07-10 01:26:57 +08:00
### Demo
2020-07-09 18:38:21 +08:00
2020-07-21 21:23:24 +08:00
[](https://github.com/anuraghazra/github-readme-stats)
2020-07-27 00:15:23 +08:00
- Compact layout
[](https://github.com/anuraghazra/github-readme-stats)
2020-07-21 21:23:24 +08:00
---
### All Demos
2020-07-09 21:16:41 +08:00
- Default
2020-07-09 18:38:21 +08:00
2020-07-09 20:20:15 +08:00
- Hiding specific stats
2020-07-26 23:14:09 +08:00
2020-07-09 20:20:15 +08:00
2020-07-09 21:16:41 +08:00
- Showing icons
2020-07-23 23:31:23 +08:00
2020-07-09 21:16:41 +08:00
2020-07-31 16:07:39 +08:00
- Include All Commits
2020-07-19 23:04:41 +08:00
- Themes
Choose from any of the [default themes ](#themes )
2020-08-10 00:41:01 +08:00
- Gradient
2020-07-12 15:46:30 +08:00
- Customizing stats card
2020-07-12 16:34:02 +08:00
2020-07-12 15:46:30 +08:00
- Customizing repo card
2020-07-12 16:34:02 +08:00
2020-07-12 15:46:30 +08:00
2020-07-21 21:23:24 +08:00
- Top languages
2020-07-10 01:26:57 +08:00
2020-07-21 21:23:24 +08:00
[](https://github.com/anuraghazra/github-readme-stats)
2020-07-10 01:26:57 +08:00
2020-07-21 21:23:24 +08:00
---
2020-07-16 20:33:33 +08:00
2020-07-10 01:26:57 +08:00
### Quick Tip (Align The Repo Cards)
2020-07-15 05:08:52 +08:00
You usually won't be able to layout the images side by side. To do that you can use this approach:
2020-07-10 01:26:57 +08:00
```md
< a href = "https://github.com/anuraghazra/github-readme-stats" >
2020-07-10 14:02:59 +08:00
< img align = "left" src = "https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats" / >
2020-07-10 01:26:57 +08:00
< / a >
< a href = "https://github.com/anuraghazra/convoychat" >
2020-07-10 14:02:59 +08:00
< img align = "left" src = "https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=convoychat" / >
2020-07-10 01:26:57 +08:00
< / a >
```
2020-07-15 03:30:03 +08:00
## Deploy on your own Vercel instance
2020-07-11 17:03:29 +08:00
2020-08-15 23:16:36 +08:00
#### [Check Out Step By Step Video Tutorial By @codeSTACKr](https://youtu.be/n6d4KHSKqGk?t=107)
2020-07-15 05:08:52 +08:00
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!
2020-07-11 17:03:29 +08:00
2020-07-16 19:52:02 +08:00
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
2020-07-11 17:03:29 +08:00
[](https://vercel.com/import/project?template=https://github.com/anuraghazra/github-readme-stats)
2020-07-15 05:08:52 +08:00
< details >
2020-08-02 15:21:47 +08:00
< summary > < b > Guide on setting up Vercel 🔨 < / b > < / summary >
2020-07-15 05:08:52 +08:00
2020-07-15 03:30:03 +08:00
1. Go to [vercel.com ](https://vercel.com/ )
2020-07-15 03:32:06 +08:00
1. Click on `Log in`
2020-07-16 16:32:15 +08:00
2020-07-15 03:32:06 +08:00
1. Sign in with GitHub by pressing `Continue with GitHub`
2020-07-16 16:32:15 +08:00
2020-07-15 03:30:03 +08:00
1. Sign into GitHub and allow access to all repositories, if prompted
1. Fork this repo
1. Go back to your [Vercel dashboard ](https://vercel.com/dashboard )
2020-07-15 05:08:52 +08:00
1. Select `Import Project`
2020-07-16 16:32:15 +08:00
2020-07-15 03:32:06 +08:00
1. Select `Import Git Repository`
2020-07-16 16:32:15 +08:00
2020-07-16 19:52:02 +08:00
1. 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 ](https://github.com/settings/tokens/new ) (leave everything as is, just name it something, it can be anything you want)
2020-07-21 15:47:38 +08:00
2020-07-15 03:30:03 +08:00
1. Click deploy, and you're good to go. See your domains to use the API!
2020-07-24 20:45:20 +08:00
2020-07-15 05:08:52 +08:00
< / details >
2020-07-11 17:03:29 +08:00
2020-07-17 01:57:23 +08:00
## :sparkling_heart: Support the project
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 :rocket:
- [](https://www.paypal.me/anuraghazra) - You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
Thanks! :heart:
2020-07-18 01:31:16 +08:00
---
2020-07-17 01:57:23 +08:00
2020-08-19 17:03:41 +08:00
2020-07-09 18:38:21 +08:00
Contributions are welcomed! < 3
2020-07-18 01:31:16 +08:00
Made with :heart: and JavaScript.
