2020-07-13 17:26:59 +08:00
< p align = "center" >
2020-07-16 22:05:18 +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 >
< 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 >
< / p >
< p align = "center" >
< a href = "#demo" > View Demo< / a >
·
< a href = "https://github.com/anuraghazra/github-readme-stats/issues" > Report Bug< / a >
·
< a href = "https://github.com/anuraghazra/github-readme-stats/issues" > Request Feature< / a >
< / p >
2020-07-19 12:00:32 +08:00
< p align = "center" >
< a href = "readme_cn.md" > 简体中文< / a >
2020-07-21 00:39:39 +08:00
·
< a href = "readme_es.md" > Español< / 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-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-15 05:08:52 +08:00
To hide any specific stats, you can pass a query parameter `?hide=` with an array of items you wanna hide.
2020-07-09 20:20:15 +08:00
2020-07-19 14:33:48 +08:00
> Options: `&hide=["stars","commits","prs","issues","contribs"]`
2020-07-09 20:20:15 +08:00
```md
![Anurag's github stats ](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=["contribs","prs"] )
```
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-20 00:05:57 +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 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
Customization Options:
2020-07-21 00:32:50 +08:00
| Option | type | description | Stats Card (default) | Repo Card (default) |
| ------------- | --------- | ------------------------------------ | -------------------- | ------------------- |
| title_color | hex color | title color | 2f80ed | 2f80ed |
| text_color | hex color | body color | 333 | 333 |
| icon_color | hex color | icon color | 4c71f2 | 586069 |
| bg_color | hex color | card bg color | FFFEFE | FFFEFE |
| line_height | number | control the line-height between text | 30 | N/A |
| hide_rank | boolean | hides the ranking | false | N/A |
| hide_title | boolean | hides the stats title | false | N/A |
| hide_border | boolean | hides the stats card border | false | N/A |
| show_owner | boolean | shows owner name in repo card | N/A | false |
| show_icons | boolean | shows icons | false | N/A |
| theme | string | sets inbuilt theme | 'default' | 'default_repocard' |
| cache_seconds | number | manually set custom cache control | 1800 | 1800 |
> Note on cache: Repo cards have default cache of 30mins (1800 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 30min and maximum of 24hours
2020-07-12 15:46:30 +08:00
2020-07-19 23:04:41 +08:00
---
2020-07-12 15:46:30 +08:00
2020-07-10 01:26:57 +08:00
### Demo
2020-07-09 18:38:21 +08:00
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
![Anurag's github stats ](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=["contribs","issues"] )
2020-07-09 21:16:41 +08:00
- Showing icons
![Anurag's github stats ](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=["issues"]&show_icons=true )
2020-07-19 23:04:41 +08:00
- Themes
Choose from any of the [default themes ](#themes )
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-19 23:04:41 +08:00
---
2020-07-15 05:08:52 +08:00
# GitHub Extra Pins
2020-07-10 01:26:57 +08:00
2020-07-15 05:08:52 +08:00
GitHub extra pins allow you to pin more than 6 repositories in your profile using a GitHub readme profile.
2020-07-10 01:26:57 +08:00
2020-07-15 05:08:52 +08:00
Yey! You are no longer limited to 6 pinned repositories.
2020-07-10 01:26:57 +08:00
### Usage
2020-07-10 18:45:03 +08:00
Copy-paste this code into your readme and change the links.
2020-07-10 01:26:57 +08:00
Endpoint: `api/pin?username=anuraghazra&repo=github-readme-stats`
```md
2020-07-10 14:02:59 +08:00
[](https://github.com/anuraghazra/github-readme-stats)
2020-07-10 01:26:57 +08:00
```
### Demo
2020-07-10 14:02:59 +08:00
[](https://github.com/anuraghazra/github-readme-stats)
2020-07-10 01:26:57 +08:00
2020-07-16 20:33:33 +08:00
Use [show_owner ](#customization ) variable to include the repo's owner username
[](https://github.com/anuraghazra/github-readme-stats)
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-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 >
< summary > Guide on setting up Vercel< / summary >
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-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-07-09 18:38:21 +08:00
Contributions are welcomed! < 3
2020-07-18 01:31:16 +08:00
Made with :heart: and JavaScript.
