mirror of
https://github.com/Aviortheking/codestats-readme.git
synced 2025-04-22 10:42:08 +00:00
Update readme.md
This commit is contained in:
parent
6972fde9e9
commit
393b75c4cb
50
readme.md
50
readme.md
@ -5,20 +5,37 @@
|
|||||||
</p>
|
</p>
|
||||||
|
|
||||||
# Features
|
# Features
|
||||||
|
- [Code::Stats Profile Card](#profile-card)
|
||||||
- [Top Languages Card](#top-languages-card)
|
- [Top Languages Card](#top-languages-card)
|
||||||
- [Themes](#themes)
|
- [Themes](#themes)
|
||||||
- [Customization](#customization)
|
- [Customization](#customization)
|
||||||
- [Deploy Yourself](#deploy-on-your-own-vercel-instance)
|
- [Deploy Yourself](#deploy-on-your-own-vercel-instance)
|
||||||
|
|
||||||
# GitHub Stats Card
|
# Profile Card
|
||||||
|
|
||||||
Copy paste this into your markdown content, and that's it. Simple!
|
Copy paste this into your markdown content, and that's it. Simple!
|
||||||
|
|
||||||
Change the `?username=` value to your GitHub's username.
|
Change the `?username=` value to your GitHub's username.
|
||||||
|
|
||||||
```md
|
```md
|
||||||
[](https://github.com/Aviortheking/codestats-readme)
|
[](https://github.com/Aviortheking/codestats-readme)
|
||||||
|
```
|
||||||
|
### Hiding individual stats
|
||||||
|
|
||||||
|
To hide any specific stats, you can pass a query parameter `?hide=` with comma separated values.
|
||||||
|
|
||||||
|
> Options: `&hide=recent_xp,xp`
|
||||||
|
|
||||||
|
```md
|
||||||
|
]
|
||||||
|
```
|
||||||
|
|
||||||
|
### Showing icons
|
||||||
|
|
||||||
|
To enable icons, you can pass `show_icons=true` in the query param, like so:
|
||||||
|
|
||||||
|
```md
|
||||||
|

|
||||||
```
|
```
|
||||||
|
|
||||||
### Themes
|
### Themes
|
||||||
@ -28,20 +45,18 @@ With inbuilt themes you can customize the look of the card without doing any [ma
|
|||||||
Use `?theme=THEME_NAME` parameter like so :-
|
Use `?theme=THEME_NAME` parameter like so :-
|
||||||
|
|
||||||
```md
|
```md
|
||||||

|

|
||||||
```
|
```
|
||||||
|
|
||||||
#### All inbuilt themes :-
|
#### All inbuilt themes :-
|
||||||
|
|
||||||
dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula
|
dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula
|
||||||
|
|
||||||
<img src="https://res.cloudinary.com/anuraghazra/image/upload/v1595174536/grs-themes_l4ynja.png" alt="GitHub Readme Stat Themes" width="600px"/>
|
|
||||||
|
|
||||||
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
|
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
|
||||||
|
|
||||||
### Customization
|
### Customization
|
||||||
|
|
||||||
You can customize the appearance of your `Stats Card` or `Repo Card` however you want with URL params.
|
You can customize the appearance of your Cards however you want with URL params.
|
||||||
|
|
||||||
#### Common Options:
|
#### Common Options:
|
||||||
|
|
||||||
@ -60,6 +75,14 @@ You can provide multiple comma separated values in bg_color option to render a g
|
|||||||
&bg_color=DEG,COLOR1,COLRO2,COLOR3...COLOR10
|
&bg_color=DEG,COLOR1,COLRO2,COLOR3...COLOR10
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Stats Card Exclusive Options:
|
||||||
|
|
||||||
|
- `hide` - Hides the specified items from stats _(Comma seperated values)_
|
||||||
|
- `hide_title` - _(boolean)_
|
||||||
|
- `hide_rank` - _(boolean)_
|
||||||
|
- `show_icons` - _(boolean)_
|
||||||
|
- `line_height` - Sets the line-height between text _(number)_
|
||||||
|
|
||||||
#### Language Card Exclusive Options:
|
#### Language Card Exclusive Options:
|
||||||
|
|
||||||
- `hide` - Hide the languages specified from the card _(Comma separated values)_
|
- `hide` - Hide the languages specified from the card _(Comma separated values)_
|
||||||
@ -129,7 +152,7 @@ You can change the default language count (5) using the `&language_count=10` opt
|
|||||||
|
|
||||||
Choose from any of the [default themes](#themes)
|
Choose from any of the [default themes](#themes)
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
- Gradient
|
- Gradient
|
||||||
|
|
||||||
@ -137,7 +160,7 @@ Choose from any of the [default themes](#themes)
|
|||||||
|
|
||||||
- Customizing stats card
|
- Customizing stats card
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
- Top languages
|
- Top languages
|
||||||
|
|
||||||
@ -151,7 +174,7 @@ You usually won't be able to layout the images side by side. To do that you can
|
|||||||
|
|
||||||
```md
|
```md
|
||||||
<a href="https://github.com/aviortheking/codestats-readme">
|
<a href="https://github.com/aviortheking/codestats-readme">
|
||||||
<img align="center" src="https://codestats-readme.vercel.app/api/top-langs/?username=aviortheking" />
|
<img align="center" src="https://codestats-readme.vercel.app/api?username=aviortheking" />
|
||||||
</a>
|
</a>
|
||||||
<a href="https://github.com/aviortheking/codestats-readme">
|
<a href="https://github.com/aviortheking/codestats-readme">
|
||||||
<img align="center" src="https://codestats-readme.vercel.app/api/top-langs/?username=aviortheking" />
|
<img align="center" src="https://codestats-readme.vercel.app/api/top-langs/?username=aviortheking" />
|
||||||
@ -160,12 +183,7 @@ You usually won't be able to layout the images side by side. To do that you can
|
|||||||
|
|
||||||
## Deploy on your own Vercel instance
|
## Deploy on your own Vercel instance
|
||||||
|
|
||||||
|
[](https://vercel.com/import/project?template=https://github.com/Aviortheking/codestats-readme/)
|
||||||
Since the GitHub API only allows 5k requests per hour, it is possible that my `https://codestats-readme.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!
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
[](https://vercel.com/import/project?template=https://github.com/anuraghazra/github-readme-stats)
|
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary><b> Guide on setting up Vercel 🔨 </b></summary>
|
<summary><b> Guide on setting up Vercel 🔨 </b></summary>
|
||||||
|
Loading…
x
Reference in New Issue
Block a user