Dynamically generated Code::Stats SVGs for your github readmes
MIT License
Copy paste this into your markdown content, and that's it. Simple!
Change the ?username=
value to your GitHub's username.
[![Avior's code::stats stats](https://codestats-readme.avior.me/api?username=aviortheking)](https://github.com/Aviortheking/codestats-readme)
Option Name | Preview | Description |
---|---|---|
hide | Hide specific line, ex: &hide=xp or &hide=xp,recent_xp
|
|
show_icons | shows icons before each lines ex: &show_icons
|
|
hide_rank | hide the rank circle ex: &hide_rank
|
|
line_height | change the line Height of each lines, ex: &line_height=45
|
|
icon_color | change the icons color, ex: &icon_color=123456&show_icons
|
|
text_color | change the text colors, ex: &text_color=123456
|
Shows your XP history as it's shown on your profile.
Copy-paste this code into your readme and change the links.
Endpoint: api/history?username=Aviortheking
[![History](https://codestats-readme.avior.me/api/history/?username=Aviortheking)](https://github.com/aviortheking/codestats-readme)
Option Name | Preview | Description |
---|---|---|
layout | Change the layout to the horizontal oneex: &layout=horizontal
|
|
height | Change the height of the card Only on horizontal layoutex: &height=400 Default: 300
|
|
width | Change the width of the card Only on vertical layoutex: &width=TypeScript Default: 500
|
|
title | Change the title of the cardex: &title=History
|
|
days_count | Change the number of days shownex: &days_count=7 Default: 14
|
|
reverse_order | Reverse the order of the daysex: &reverse_order
|
|
hide | Hide specifics languages and put them in Othersex: &hide=TypeScript
|
|
language_count | Change the number of languages shown before going to Othersex: &language_count=3 defaults: 8
|
|
text_color | change the text colorsex: &text_color=654321
|
Top languages card shows user's top languages.
Copy-paste this code into your readme and change the links.
Endpoint: api/top-langs?username=aviortheking
[![Top Langs](https://codestats-readme.avior.me/api/top-langs/?username=aviortheking)](https://github.com/aviortheking/codestats-readme)
Option Name | Preview | Description |
---|---|---|
hide | Hide Specific languageex: &hide=TypeScript or &hide=TypeScript,TypeScript%20(JSX)
|
|
language_count | Change the number of languages shown before going to Othersex: &language_count=3 defaults: 8
|
|
card_width | hide the rank circleex: &card_width=600 defaults: 300
|
|
layout | make the layout more compactex: &layout=compact
|
|
text_color | change the text colorsex: &text_color=654321
|
Options Name | Preview | Description |
---|---|---|
title_color | Change the title colorex: &title_color=654321
|
|
bg_color | Change the background colorex: &bg_color=654321
|
|
hide_border | Hide the borderex: &hide_border
|
|
hide_title | Hide the titleex: &hide_border
|
|
theme | See #themes | |
cache_seconds | set the cache header manually (min: 1800, max: 86400)ex: &cache_seconds=86400 Default: 1800 or 30 minutes |
With inbuilt themes you can customize the look of the card without doing any manual customization.
Use ?theme=THEME_NAME
parameter like so :-
![Aviortheking's Code::Stats stats](https://codestats-readme.avior.me/api?username=aviortheking&show_icons=true&theme=nightowl)
dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula
You can look at a preview for all available themes or checkout the theme config file & you can also contribute new themes if you like :D
You usually won't be able to layout the images side by side. To do that you can use this approach:
<a href="https://github.com/aviortheking/codestats-readme">
<img align="center" src="https://codestats-readme.avior.me/api?username=aviortheking" />
</a>
<a href="https://github.com/aviortheking/codestats-readme">
<img align="center" src="https://codestats-readme.avior.me/api/top-langs/?username=aviortheking" />
</a>
docker build . --tag your-tag
docker run your-tag
Contributions are welcomed! <3
Made with ❤️ and Typescript.