githubprofile-trophyGitHub Profile Trophy
githubprofile-trophy
🏆 Add dynamically generated GitHub Stat Trophies on your README
Quick Start
Add the following code to your readme. When pasting the code into your profile's readme, change the ?username= value to your GitHub's username.
[](https://github.com/krishyadav90/github-profile-trophy)
Use theme
Add optional parameter of the theme.
[](https://github.com/krishyadav90/github-profile-trophy)
About Rank
Ranks are SSS SS S AAA AA A B C UNKNOWN SECRET.
| Rank | Description |
|---|---|
| SSS, SS, S | You are at a hard to reach rank. You can brag. |
| AAA, AA, A | You will reach this rank if you do your best. Let's aim here first. |
| B, C | You are currently making good progress. Let's aim a bit higher. |
| UNKNOWN | You have not taken action yet. Let's act first. |
| SECRET | This rank is very rare. The trophy will not be displayed until certain conditions are met. |
NOTE: The UNKNOWN rank is denoted by ?
Secret Rank
The acquisition condition is secret, but you can see this.
There are only a few secret trophies. Therefore, if you come up with interesting conditions, I will consider adding a trophy. I am waiting for contributions.
About Display details
- Title name of aggregation target.
- Current rank.
- Title according to rank.
- Target aggregation result.
- Rank progress bar.
Optional Request Parameters
Filter by titles
You can filter the display by specifying the titles of trophy.
https://github-profile-trophy.vercel.app/?username=krishyadav90&title=Followers
If you want to specify multiple titles.
https://github-profile-trophy.vercel.app/?username=krishyadav90&title=Stars,Followers
You can also exclude the trophies you don't want to display.
https://github-profile-trophy.vercel.app/?username=krishyadav90&title=-Stars,-Followers
Filter by ranks
You can filter the display by specifying the ranks.
Available values: SECRET SSS SS S AAA AA A B C
https://github-profile-trophy.vercel.app/?username=krishyadav90&rank=S
If you want to specify multiple ranks.
https://github-profile-trophy.vercel.app/?username=krishyadav90&rank=S,AAA
You can also exclude ranks.
https://github-profile-trophy.vercel.app/?username=krishyadav90&rank=-C,-B
NOTE: Since UNKNOWN is denoted by ?, in order to include or exclude it you will have to use rank=? and rank=-? respectively
Specify the maximum row & column size
You can specify the maximum row and column size.
Trophy will be hidden if it exceeds the range of both row and column.
Available value: number type
Default: column=6 row=3
Restrict only row
https://github-profile-trophy.vercel.app/?username=krishyadav90&row=2
Restrict only column
https://github-profile-trophy.vercel.app/?username=krishyadav90&column=2
Restrict row & column
https://github-profile-trophy.vercel.app/?username=krishyadav90&row=2&column=3
Adaptive column
https://github-profile-trophy.vercel.app/?username=krishyadav90&column=-1
You can set column to -1 to adapt the width to the number of trophies, the parameter row will be ignored.
Apply theme
Available themes.
flat
https://github-profile-trophy.vercel.app/?username=krishyadav90&theme=flat
onedark
https://github-profile-trophy.vercel.app/?username=krishyadav90&theme=onedark
gruvbox
https://github-profile-trophy.vercel.app/?username=krishyadav90&theme=gruvbox
dracula
https://github-profile-trophy.vercel.app/?username=krishyadav90&theme=dracula
monokai
https://github-profile-trophy.vercel.app/?username=krishyadav90&theme=monokai
chalk
https://github-profile-trophy.vercel.app/?username=krishyadav90&theme=chalk
nord
https://github-profile-trophy.vercel.app/?username=krishyadav90&theme=nord
alduin
https://github-profile-trophy.vercel.app/?username=krishyadav90&theme=alduin
darkhub
https://github-profile-trophy.vercel.app/?username=krishyadav90&theme=darkhub
juicyfresh
https://github-profile-trophy.vercel.app/?username=krishyadav90&theme=juicyfresh
buddhism
https://github-profile-trophy.vercel.app/?username=krishyadav90&theme=buddhism
oldie
https://github-profile-trophy.vercel.app/?username=krishyadav90&theme=oldie
radical
https://github-profile-trophy.vercel.app/?username=krishyadav90&theme=radical
onestar
https://github-profile-trophy.vercel.app/?username=krishyadav90&theme=onestar
discord
https://github-profile-trophy.vercel.app/?username=krishyadav90&theme=discord
algolia
https://github-profile-trophy.vercel.app/?username=krishyadav90&theme=algolia
gitdimmed
https://github-profile-trophy.vercel.app/?username=krishyadav90&theme=gitdimmed
tokyonight
https://github-profile-trophy.vercel.app/?username=krishyadav90&theme=tokyonight
matrix
https://github-profile-trophy.vercel.app/?username=krishyadav90&theme=matrix
apprentice
https://github-profile-trophy.vercel.app/?username=krishyadav90&theme=apprentice
dark_dimmed
https://github-profile-trophy.vercel.app/?username=krishyadav90&theme=dark_dimmed
dark_lover
https://github-profile-trophy.vercel.app/?username=krishyadav90&theme=dark_lover
kimbie_dark
https://github-profile-trophy.vercel.app/?username=krishyadav90&theme=kimbie_dark
aura
https://github-profile-trophy.vercel.app/?username=krishyadav90&theme=aura
Margin Width
You can put a margin in the width between trophies.
Available value: number type
Default: margin-w=0
https://github-profile-trophy.vercel.app/?username=krishyadav90&margin-w=15
Margin Height
You can put a margin in the height between trophies.
Available value: number type
Default: margin-h=0
https://github-profile-trophy.vercel.app/?username=krishyadav90&margin-h=15
Example layout
https://github-profile-trophy.vercel.app/?username=krishyadav90&column=3&margin-w=15&margin-h=15
Transparent background
You can turn the background transparent.
Available value: boolean type (true or false)
Default: no-bg=false
https://github-profile-trophy.vercel.app/?username=krishyadav90&no-bg=true
Hide frames
You can hide the frames around the trophies.
Available value: boolean type (true or false)
Default: no-frame=false
https://github-profile-trophy.vercel.app/?username=krishyadav90&no-frame=true
License
This product is licensed under the MIT License.
0 commit comments