Skip to content
/ gh-stats Public

⚡ Dynamically generated stats for your github readmes

License

Notifications You must be signed in to change notification settings

D3OXY/gh-stats

Note This Repo Was Originally Created By Anurag Hazra. This is just a fork for private use.

GitHub Readme Stats

GitHub Readme Stats

Get dynamically generated GitHub stats on your READMEs!

Features

GitHub Stats Card

Copy-paste this into your markdown content, and that is it. Simple!

Change the ?username= value to your GitHub username.

[![Ishan's GitHub stats](https://gh-stats.deoxy.dev/api?username=d3oxy)](https://deoxy.dev)

Note Available ranks are S+ (top 1%), S (top 25%), A++ (top 45%), A+ (top 60%), and B+ (everyone). The values are calculated by using the cumulative distribution function using commits, contributions, issues, stars, pull requests, followers, and owned repositories. The implementation can be investigated at src/calculateRank.js.

Hiding individual stats

You can pass a query parameter &hide= to hide any specific stats with comma-separated values.

Options: &hide=stars,commits,prs,issues,contribs

![Ishan's GitHub stats](https://gh-stats.deoxy.dev/api?username=d3oxy&hide=contribs,prs)

Adding private contributions count to total commits count

You can add the count of all your private contributions to the total commits count by using the query parameter &count_private=true.

Note If you are deploying this project yourself, the private contributions will be counted by default. If you are using the public Vercel instance, you need to choose to share your private contributions.

Options: &count_private=true

![Ishan's GitHub stats](https://gh-stats.deoxy.dev/api?username=d3oxy&count_private=true)

Showing icons

To enable icons, you can pass &show_icons=true in the query param, like so:

![Ishan's GitHub stats](https://gh-stats.deoxy.dev/api?username=d3oxy&show_icons=true)

Themes

With inbuilt themes, you can customize the look of the card without doing any manual customization.

Use &theme=THEME_NAME parameter like so :

![Ishan's GitHub stats](https://gh-stats.deoxy.dev/api?username=d3oxy&show_icons=true&theme=radical)

All inbuilt themes

GitHub readme stats comes with several built-in themes (e.g. dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula).

GitHub Readme Stats Themes

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

Responsive Card Theme

Ishan's GitHub stats-Dark Ishan's GitHub stats-Light

Since GitHub will re-upload the cards and serve them from their CDN, we can not infer the browser/GitHub theme on the server side. There are, however, four methods you can use to create dynamics themes on the client side.

Use the transparent theme

We have included a transparent theme that has a transparent background. This theme is optimized to look good on GitHub's dark and light default themes. You can enable this theme using the &theme=transparent parameter like so:

![Ishan's GitHub stats](https://gh-stats.deoxy.dev/api?username=d3oxy&show_icons=true&theme=transparent)
👀 Show example

Ishan's GitHub stats

Add transparent alpha channel to a themes bg_color

You can use the bg_color parameter to make any of the available themes transparent. This is done by setting the bg_color to a colour with a transparent alpha channel (i.e. bg_color=00000000):

![Ishan's GitHub stats](https://gh-stats.deoxy.dev/api?username=d3oxy&show_icons=true&bg_color=00000000)
👀 Show example

Ishan's GitHub stats

Use GitHub's theme context tag

You can use GitHub's theme context tags to switch the theme based on the user GitHub theme automatically. This is done by appending #gh-dark-mode-only or #gh-light-mode-only to the end of an image URL. This tag will define whether the image specified in the markdown is only shown to viewers using a light or a dark GitHub theme:

[![Ishan's GitHub stats-Dark](https://gh-stats.deoxy.dev/api?username=d3oxy&show_icons=true&theme=dark#gh-dark-mode-only)](https://github.com/d3oxy/gh-stats#gh-dark-mode-only)
[![Ishan's GitHub stats-Light](https://gh-stats.deoxy.dev/api?username=d3oxy&show_icons=true&theme=default#gh-light-mode-only)](https://github.com/d3oxy/gh-stats#gh-light-mode-only)
👀 Show example

Ishan's GitHub stats-Dark Ishan's GitHub stats-Light

Use GitHub's new media feature

You can use GitHub's new media feature in HTML to specify whether to display images for light or dark themes. This is done using the HTML <picture> element in combination with the prefers-color-scheme media feature.

<picture>
<source 
  srcset="https://gh-stats.deoxy.dev/api?username=d3oxy&show_icons=true&theme=dark"
  media="(prefers-color-scheme: dark)"
/>
<source
  srcset="https://gh-stats.deoxy.dev/api?username=d3oxy&show_icons=true"
  media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)"
/>
<img src="https://gh-stats.deoxy.dev/api?username=d3oxy&show_icons=true" />
</picture>
👀 Show example

Customization

You can customize the appearance of your Stats Card or Repo Card however you wish with URL parameters.

Common Options

  • title_color - Card's title color (hex color). Default: 2f80ed.
  • text_color - Body text color (hex color). Default: 434d58.
  • icon_color - Icons color if available (hex color). Default: 4c71f2.
  • border_color - Card's border color (hex color). Default: e4e2e2 (Does not apply when hide_border is enabled).
  • bg_color - Card's background color (hex color) or a gradient in the form of angle,start,end. Default: fffefe
  • hide_border - Hides the card's border (boolean). Default: false
  • theme - name of the theme, choose from all available themes. Default: default theme.
  • cache_seconds - set the cache header manually (min: 14400, max: 86400). Default: 14400 seconds (4 hours).
  • locale - set the language in the card (e.g. cn, de, es, etc.). Default: en.
  • border_radius - Corner rounding on the card. Default: 4.5.
Gradient in bg_color

You can provide multiple comma-separated values in the bg_color option to render a gradient with the following format:

&bg_color=DEG,COLOR1,COLOR2,COLOR3...COLOR10

Stats Card Exclusive Options

  • hide - Hides the specified items from stats (Comma-separated values). Default: [] (blank array).
  • hide_title - (boolean). Default: false.
  • card_width - Set the card's width manually (number). Default: 500px (approx.).
  • hide_rank - (boolean) hides the rank and automatically resizes the card width. Default: false.
  • show_icons - (boolean). Default: false.
  • include_all_commits - Count total commits instead of just the current year commits (boolean). Default: false.
  • count_private - Count private commits (boolean). Default: false.
  • line_height - Sets the line height between text (number). Default: 25.
  • exclude_repo - Exclude stars from specified repositories (Comma-separated values). Default: [] (blank array).
  • custom_title - Sets a custom title for the card. Default: <username> GitHub Stats.
  • text_bold - Use bold text (boolean). Default: true.
  • disable_animations - Disables all animations in the card (boolean). Default: false.
  • ring_color - Color of the rank circle (hex color). Defaults to the theme ring color if it exists and otherwise the title color.

Note When hide_rank=true, the minimum card width is 270 px + the title length and padding.

Repo Card Exclusive Options

  • show_owner - Show the repo's owner name (boolean). Default: false.

Language Card Exclusive Options

  • hide - Hide the languages specified from the card (Comma-separated values). Default: [] (blank array).
  • hide_title - (boolean). Default: false.
  • layout - Switch between two available layouts default & compact. Default: default.
  • card_width - Set the card's width manually (number). Default 300.
  • langs_count - Show more languages on the card, between 1-10 (number). Default 5.
  • exclude_repo - Exclude specified repositories (Comma-separated values). Default: [] (blank array).
  • custom_title - Sets a custom title for the card (string). Default Most Used Languages.
  • disable_animations - Disables all animations in the card (boolean). Default: false.
  • hide_progress - It uses the compact layout option, hides percentages, and removes the bars. Default: false.

Warning Language names should be URI-escaped, as specified in Percent Encoding (i.e: c++ should become c%2B%2B, jupyter notebook should become jupyter%20notebook, etc.) You can use urlencoder.org to help you do this automatically.

Wakatime Card Exclusive Options

  • hide - Hide the languages specified from the card (Comma-separated values). Default: [] (blank array).
  • hide_title - (boolean). Default false.
  • line_height - Sets the line height between text (number). Default 25.
  • hide_progress - Hides the progress bar and percentage (boolean). Default false.
  • custom_title - Sets a custom title for the card (string). Default Wakatime Stats.
  • layout - Switch between two available layouts default & compact. Default default.
  • langs_count - Limit the number of languages on the card, defaults to all reported languages (number).
  • api_domain - Set a custom API domain for the card, e.g. to use services like Hakatime or Wakapi (string). Default Waka API.
  • range – Request a range different from your WakaTime default, e.g. last_7_days. See WakaTime API docs for a list of available options. (YYYY-MM, last_7_days, last_30_days, last_6_months, last_year, or all_time). Default all_time.

GitHub Extra Pins

GitHub extra pins allow you to pin more than six repositories in your profile using a GitHub readme profile.

Yay! 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=d3oxy&repo=github-readme-stats

[![Readme Card](https://gh-stats.deoxy.dev/api/pin/?username=d3oxy&repo=gh-stats)](https://deoxy.dev)

Demo

Readme Card

Use show_owner variable to include the repo's owner username

Readme Card

Top Languages Card

The top languages card shows a GitHub user's most frequently used top language.

Note Top Languages does not indicate my skill level or anything like that; it's a GitHub metric to determine which languages have the most code on GitHub. It is a new feature of github-readme-stats.

Usage

Copy-paste this code into your readme and change the links.

Endpoint: api/top-langs?username=d3oxy

[![Top Langs](https://gh-stats.deoxy.dev/api/top-langs/?username=d3oxy)](https://deoxy.dev)

Exclude individual repositories

You can use the &exclude_repo=repo1,repo2 parameter to exclude individual repositories.

[![Top Langs](https://gh-stats.deoxy.dev/api/top-langs/?username=d3oxy&exclude_repo=github-readme-stats,anuraghazra.github.io)](https://deoxy.dev)

Hide individual languages

You can use &hide=language1,language2 parameter to hide individual languages.

[![Top Langs](https://gh-stats.deoxy.dev/api/top-langs/?username=d3oxy&hide=javascript,html)](https://deoxy.dev)

Show more languages

You can use the &langs_count= option to increase or decrease the number of languages shown on the card. Valid values are integers between 1 and 10 (inclusive), and the default is 5.

[![Top Langs](https://gh-stats.deoxy.dev/api/top-langs/?username=d3oxy&langs_count=8)](https://deoxy.dev)

Compact Language Card Layout

You can use the &layout=compact option to change the card design.

[![Top Langs](https://gh-stats.deoxy.dev/api/top-langs/?username=d3oxy&layout=compact)](https://deoxy.dev)

Hide Progress Bars

You can use the &hide_progress=true option to hide the percentages and the progress bars (layout will be automatically set to compact).

[![Top Langs](https://gh-stats.deoxy.dev/api/top-langs/?username=d3oxy&hide_progress=true)](https://deoxy.dev)

Demo

Top Langs

  • Compact layout

Top Langs

  • Hidden progress bars

Top Langs

Wakatime Week Stats

Change the ?username= value to your Wakatime username.

[![Ishan's wakatime stats](https://gh-stats.deoxy.dev/api/wakatime?username=D3OXY)](https://deoxy.dev)

Note: Please be aware that we currently only show data from Wakatime profiles that are public.

Demo

Ishan's wakatime stats

Ishan's wakatime stats

  • Compact layout

Ishan's wakatime stats


All Demos

  • Default

Ishan's GitHub stats

  • Hiding specific stats

Ishan's GitHub stats3

  • Showing icons

Ishan's GitHub stats

  • Customize Border Color

Ishan's GitHub stats

  • Include All Commits

Ishan's GitHub stats

  • Themes

Choose from any of the default themes

Ishan's GitHub stats

  • Gradient

Ishan's GitHub stats

  • Customizing stats card

Ishan's GitHub stats

  • Setting card locale

Ishan's GitHub stats

  • Customizing repo card

Customized Card

  • Top languages

Top Langs

  • WakaTime card

Ishan's wakatime stats


Quick Tip (Align The Repo Cards)

By default, GitHub does not lay out the cards side by side. To do that, you can use this approach:

<a href="https://github.com/d3oxy/gh-stats">
  <img align="center" src="https://gh-stats.deoxy.dev/api/pin/?username=d3oxy&repo=github-readme-stats" />
</a>
<a href="https://github.com/anuraghazra/convoychat">
  <img align="center" src="https://gh-stats.deoxy.dev/api/pin/?username=d3oxy&repo=convoychat" />
</a>

💖 Support the project

Support the Original Creator of this project by giving a ⭐ on the project and sharing it with your friends via social media. Anurag Hazra

Thanks! ❤️


https://vercel.com?utm_source=github_readme_stats_team&utm_campaign=oss

Contributions are welcome! <3

Made with ❤️ and JavaScript.

About

⚡ Dynamically generated stats for your github readmes

Resources

License

Code of conduct

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published