mirror of
https://github.com/Aviortheking/codestats-readme.git
synced 2025-04-22 18:42:09 +00:00
169 lines
6.5 KiB
Markdown
169 lines
6.5 KiB
Markdown
<p align="center">
|
|
<h2 align="center">Github Readme Stats</h2>
|
|
<p align="center">Get dynamically generated GitHub stats on your readmes!</p>
|
|
|
|
<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>
|
|
</p>
|
|
|
|
# Features
|
|
|
|
- [Github Stats Card](#github-stats-card)
|
|
- [Github Extra Pins](#github-extra-pins)
|
|
- [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 GitHubs's username
|
|
|
|
```md
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
```
|
|
|
|
_Note: Ranks are calculated based on users stats, see [src/calculateRank.js](./src/calculateRank.js)_
|
|
|
|
### Hiding individual stats
|
|
|
|
To hide any specific stats, you can pass a query parameter `?hide=` with an array of items, you wanna hide.
|
|
|
|
> Options: `&hide=["stars","prs","issues","contribs"]`
|
|
|
|
```md
|
|
![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=["contribs","prs"])
|
|
```
|
|
|
|
### Showing icons
|
|
|
|
To enable icons, you can pass `show_icons=true` in the query param like so
|
|
|
|
```md
|
|
|
|
```
|
|
|
|
Other options:
|
|
|
|
- `&hide_border=true` hide the border box if you don't like it :D.
|
|
- `&line_height=30` control the line-height between text.
|
|
- `&hide_rank=true` hides the ranking
|
|
|
|
### 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
|
|
|
|
```
|
|
|
|
### Demo
|
|
|
|
- Default
|
|
|
|
|
|
|
|
- Hiding specific stats
|
|
|
|
![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=["contribs","issues"])
|
|
|
|
- Showing icons
|
|
|
|
![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=["issues"]&show_icons=true)
|
|
|
|
- Customizing stats card
|
|
|
|
|
|
|
|
- Customizing repo card
|
|
|
|
|
|
|
|
# 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)
|
|
|
|
### 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
|
|
<a href="https://github.com/anuraghazra/github-readme-stats">
|
|
<img align="left" src="https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats" />
|
|
</a>
|
|
<a href="https://github.com/anuraghazra/convoychat">
|
|
<img align="left" src="https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=convoychat" />
|
|
</a>
|
|
```
|
|
|
|
## 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)
|
|
|
|
### Guide on setting up Vercel
|
|
1. Go to [vercel.com](https://vercel.com/)
|
|
1. Click on `Log in`
|
|
|
|
1. Sign in with GitHub by pressing `Continue with GitHub`
|
|
|
|
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)
|
|
1. Select `Import project`
|
|
|
|
1. Select `Import Git Repository`
|
|
|
|
1. Select root and keep everything as is, just add your environment variable named GITHUB_TOKEN (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, can be anything you want.)
|
|
|
|
1. Click deploy, and you're good to go. See your domains to use the API!
|
|
|
|
Contributions are welcomed! <3
|
|
|
|
Made with :heart: and JavaScript.
|