2020-07-09 18:38:21 +08:00
## Github Readme stats
2020-07-12 02:12:08 +08:00
[](https://github.com/anuraghazra/github-readme-stats/actions)
[](https://github.com/anuraghazra/github-readme-stats/issues)
[](https://github.com/anuraghazra/github-readme-stats/pulls)
2020-07-10 18:45:03 +08:00
Get dynamically generated GitHub stats on your readmes!
2020-07-09 18:38:21 +08:00
2020-07-10 01:26:57 +08:00
# Features
- [Github Stats Card ](#github-stats-card )
- [Github Extra Pins ](#github-extra-pins )
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
# 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
change the `?username=` value to your GitHubs's username
2020-07-10 18:49:52 +08:00
```md
[](https://github.com/anuraghazra/github-readme-stats)
```
2020-07-10 18:45:03 +08:00
### Hiding individual stats
2020-07-09 20:20:15 +08:00
2020-07-10 18:45:03 +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
> Options: `&hide=["stars","prs","issues","contribs"]`
```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-10 18:45:03 +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-09 23:04:10 +08:00
Other options:
- `&hide_border=true` hide the border box if you don't like it :D.
2020-07-09 23:59:50 +08:00
- `&line_height=30` control the line-height between text.
2020-07-09 23:04:10 +08:00
2020-07-12 15:46:30 +08:00
### Customization
You can customize the appearance of your `Stats Card` or `Repo Card` however you want with url params.
Customization Options:
| Option | type | Stats Card (default) | Repo Card (default) |
| ----------- | --------- | ---------------------- | ---------------------- |
| title_color | hex color | #2f80ed | #2f80ed |
| text_color | hex color | #333 | #333 |
| icon_color | hex color | #4c71f2 | #586069 |
| bg_color | hex color | rgba(255, 255, 255, 0) | rgba(255, 255, 255, 0) |
- You can also customize the cards to be compatible with dark mode
```md
```
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-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-10 01:26:57 +08:00
# Github Extra Pins
2020-07-10 18:45:03 +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-10 18:45:03 +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
### Quick Tip (Align The Repo Cards)
2020-07-10 18:45:03 +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-11 17:03:29 +08:00
## Deploy on your own vercel instance
Since 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 thats why if you want to host it on your own vercel server then you don't have to worry about anything. click on the deploy button to get started
[](https://vercel.com/import/project?template=https://github.com/anuraghazra/github-readme-stats)
Make sure to add your own `GITHUB_TOKEN` in `Environment Variables`
[Github Docs: Creating a github personal token ](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token )
2020-07-09 18:38:21 +08:00
Contributions are welcomed! < 3
Made with :heart: and javascript.
