avior/codestats-readme
1
0
Fork 0
mirror of https://github.com/Aviortheking/codestats-readme.git synced 2025-04-22 10:42:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: added docs for customization options

Browse Source
This commit is contained in:
anuraghazra 2020-07-12 13:16:30 +05:30
parent 9af56df2c1
commit 5cf82b0194
1 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
readme.md
View File

@ -10,6 +10,7 @@ Get dynamically generated GitHub stats on your readmes!
- [Github Stats Card](#github-stats-card) - [Github Stats Card](#github-stats-card)
- [Github Extra Pins](#github-extra-pins) - [Github Extra Pins](#github-extra-pins)
- [Customization](#customization)
- [Deploy Yourself](#deploy-on-your-own-vercel-instance) - [Deploy Yourself](#deploy-on-your-own-vercel-instance)
# Github Stats Card # Github Stats Card
@ -45,6 +46,25 @@ Other options:
- `&hide_border=true` hide the border box if you don't like it :D. - `&hide_border=true` hide the border box if you don't like it :D.
- `&line_height=30` control the line-height between text. - `&line_height=30` control the line-height between text.
### 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
![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra?username=anuraghazra&repo=github-readme-stats&title_color=fff&icon_color=f9f9f9&text_color=9f9f9f&bg_color=151515])
```
### Demo ### Demo
- Default - Default
@ -59,6 +79,14 @@ Other options:
![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=["issues"]&show_icons=true) ![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=["issues"]&show_icons=true)
- Customizing stats card
![Anurag's github stats](https://github-readme-stats.vercel.app/api/?username=anuraghazra&repo=github-readme-stats&show_icons=true&title_color=fff&icon_color=79ff97&text_color=9f9f9f&bg_color=151515])
- Customizing repo card
![Customized Card](https://github-readme-stats.vercel.app/api/pin?username=anuraghazra&repo=github-readme-stats&title_color=fff&icon_color=f9f9f9&text_color=9f9f9f&bg_color=151515])
# Github Extra Pins # Github Extra Pins
Github extra pins allow you to pin more than 6 repositories in your profile using a GitHub readme profile. Github extra pins allow you to pin more than 6 repositories in your profile using a GitHub readme profile.