Skip to content

FutureUnreal/github-readme-stats-enhanced

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

GitHub Readme Stats Enhanced

GitHub Readme Stats Enhanced

Enhanced github-readme-stats with managed organization repositories support!

🚀 New Feature: Statistics from managed organization repositories!

View Demo · 🆕 Managed Repos Feature · Deploy Guide · 简体中文

📋 About This Project

This is an enhanced version of anuraghazra/github-readme-stats with the following new features:

🆕 New Features

  • Managed Repository Statistics - Statistics from organization repositories you manage (ADMIN/MAINTAIN permissions)
  • Precise Permission Control - Only count repositories you actually manage
  • Enhanced Stars Statistics - Include stars from managed organization repositories
  • Enhanced Language Statistics - Include languages from managed organization repositories

💡 Why This Feature?

The original github-readme-stats only counts repositories you own, but if you're a manager of certain projects in organizations, those repositories' contributions won't be counted. This enhanced version solves that problem!

🔥 Managed Repositories Feature {#managed-repositories-feature}

Quick Start

Simply add the include_managed_repos=true parameter to your existing URLs:

GitHub Stats Card

![GitHub stats](https://github-readme-stats-enhanced.vercel.app/api?username=yourusername&include_managed_repos=true)

Top Languages Card

![Top Languages](https://github-readme-stats-enhanced.vercel.app/api/top-langs?username=yourusername&include_managed_repos=true)

Permission Levels

Organization repositories counted:

  • ADMIN - Administrator
  • MAINTAIN - Maintainer
  • WRITE - Not counted
  • TRIAGE - Not counted
  • READ - Not counted

Features

🆕 Enhanced Features

📊 Original Features

🚀 Deployment

Important Notices

Important

Enhanced version of anuraghazra/github-readme-stats with managed repository statistics. Since GitHub API allows 5k requests per hour, deploy your own instance for best experience.

Warning

Managed Repository Feature Notes:

  • include_managed_repos=true only works correctly when using your own deployed instance with your own GitHub token
  • Using someone else's instance will not detect your organization repository permissions correctly
  • This feature queries more repository data and may trigger GitHub API rate limits more easily

Recommendations:

  • Deploy your own Vercel instance for full functionality
  • Use appropriate cache settings
  • Avoid frequent refreshing

Tip

Recommended Usage:

  1. Fork this project
  2. Deploy to your own Vercel account
  3. Configure your GitHub API Token
  4. Enjoy the complete managed repository statistics functionality!

🔄 Relationship with Original Project

Enhanced version of github-readme-stats with managed repository statistics. Thanks to @anuraghazra for the excellent work!

GitHub Stats Card

Copy and paste this into your markdown!

Change the ?username= value to your GitHub username.

Basic Usage

[![GitHub stats](https://github-readme-stats-enhanced.vercel.app/api?username=yourusername)](https://github.com/FutureUnreal/github-readme-stats-enhanced)

🆕 Including Managed Repositories

[![GitHub stats](https://github-readme-stats-enhanced.vercel.app/api?username=yourusername&include_managed_repos=true)](https://github.com/FutureUnreal/github-readme-stats-enhanced)

Warning

By default, the stats card only shows statistics like stars, commits, and pull requests from public repositories. To show private statistics on the stats card, you should deploy your own instance using your own GitHub API token.

Tip

New Feature: Use the include_managed_repos=true parameter to count repositories you manage in organizations!

Note

Available ranks are S (top 1%), A+ (12.5%), A (25%), A- (37.5%), B+ (50%), B (62.5%), B- (75%), C+ (87.5%) and C (everyone). This ranking scheme is based on the Japanese academic grading system.

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

![GitHub stats](https://github-readme-stats-enhanced.vercel.app/api?username=yourusername&hide=contribs,prs)

Showing additional individual stats

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

Options: &show=reviews,discussions_started,discussions_answered,prs_merged,prs_merged_percentage

![GitHub stats](https://github-readme-stats-enhanced.vercel.app/api?username=yourusername&show=reviews,discussions_started,discussions_answered,prs_merged,prs_merged_percentage)

Showing icons

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

![FutureUnreal's GitHub stats](https://github-readme-stats-enhanced.vercel.app/api?username=FutureUnreal&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 :

![FutureUnreal's GitHub stats](https://github-readme-stats-enhanced.vercel.app/api?username=FutureUnreal&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. Please note that we paused the addition of new themes to decrease maintenance efforts; all pull requests related to new themes will be closed.

Responsive Card Theme

You can create dynamic themes that adapt to GitHub's light/dark mode:

Use the transparent theme
![GitHub stats](https://github-readme-stats-enhanced.vercel.app/api?username=yourusername&theme=transparent)
Use GitHub's theme context tags
[![GitHub stats-Dark](https://github-readme-stats-enhanced.vercel.app/api?username=yourusername&theme=dark#gh-dark-mode-only)](https://github.com/FutureUnreal/github-readme-stats-enhanced#gh-dark-mode-only)
[![GitHub stats-Light](https://github-readme-stats-enhanced.vercel.app/api?username=yourusername&theme=default#gh-light-mode-only)](https://github.com/FutureUnreal/github-readme-stats-enhanced#gh-light-mode-only)

Customization

You can customize the appearance of all your cards however you wish with URL parameters.

Common Options

Name Description Type Default value
title_color Card's title color. string (hex color) 2f80ed
text_color Body text color. string (hex color) 434d58
icon_color Icons color if available. string (hex color) 4c71f2
border_color Card's border color. Does not apply when hide_border is enabled. string (hex color) e4e2e2
bg_color Card's background color. string (hex color or a gradient in the form of angle,start,end) fffefe
hide_border Hides the card's border. boolean false
theme Name of the theme, choose from all available themes. enum default
cache_seconds Sets the cache header manually (min: 21600, max: 86400). integer 21600
locale Sets the language in the card, you can check full list of available locales here. enum en
border_radius Corner rounding on the card. number 4.5

Warning

We use caching to decrease the load on our servers. Our cards have a default cache of 6 hours (21600 seconds). Also, note that the cache is clamped to a minimum of 6 hours and a maximum of 24 hours. If you want the data on your statistics card to be updated more often you can deploy your own instance and set environment variable CACHE_SECONDS to a value of your choosing.

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
Available locales

Here is a list of all available locales:

Code Locale
cn Chinese
zh-tw Chinese (Taiwan)
ar Arabic
cs Czech
de German
en English
bn Bengali
es Spanish
fr French
hu Hungarian
Code Locale
it Italian
ja Japanese
kr Korean
nl Dutch
pt-pt Portuguese (Portugal)
pt-br Portuguese (Brazil)
np Nepali
el Greek
ru Russian
uk-ua Ukrainian
Code Locale
id Indonesian
ml Malayalam
my Burmese
sk Slovak
tr Turkish
pl Polish
uz Uzbek
vi Vietnamese
se Swedish

If we don't support your language, please consider contributing! You can find more information about how to do it in our contributing guidelines.

Stats Card Exclusive Options

Name Description Type Default value
hide Hides the specified items from stats. string (comma-separated values) null
hide_title Hides the title of your stats card. boolean false
card_width Sets the card's width manually. number 500px (approx.)
hide_rank Hides the rank and automatically resizes the card width. boolean false
rank_icon Shows alternative rank icon (i.e. github, percentile or default). enum default
show_icons Shows icons near all stats. boolean false
include_all_commits Count total commits instead of just the current year commits. boolean false
line_height Sets the line height between text. integer 25
exclude_repo Excludes specified repositories. string (comma-separated values) null
custom_title Sets a custom title for the card. string <username> GitHub Stats
text_bold Uses bold text. boolean true
disable_animations Disables all animations in the card. boolean false
ring_color Color of the rank circle. string (hex color) 2f80ed
number_format Switches between two available formats for displaying the card values short (i.e. 6.6k) and long (i.e. 6626). enum short
show Shows additional items on stats card (i.e. reviews, discussions_started, discussions_answered, prs_merged or prs_merged_percentage). string (comma-separated values) null

Note

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

Repo Card Exclusive Options

Name Description Type Default value
show_owner Shows the repo's owner name. boolean false
description_lines_count Manually set the number of lines for the description. Specified value will be clamped between 1 and 3. If this parameter is not specified, the number of lines will be automatically adjusted according to the actual length of the description. number null

Gist Card Exclusive Options

Name Description Type Default value
show_owner Shows the gist's owner name. boolean false

Language Card Exclusive Options

Name Description Type Default value
hide Hides the specified languages from card. string (comma-separated values) null
hide_title Hides the title of your card. boolean false
layout Switches between five available layouts normal & compact & donut & donut-vertical & pie. enum normal
card_width Sets the card's width manually. number 300
langs_count Shows more languages on the card, between 1-20. integer 5 for normal and donut, 6 for other layouts
exclude_repo Excludes specified repositories. string (comma-separated values) null
custom_title Sets a custom title for the card. string Most Used Languages
disable_animations Disables all animations in the card. boolean false
hide_progress Uses the compact layout option, hides percentages, and removes the bars. boolean false
size_weight Configures language stats algorithm (see Language stats algorithm). integer 1
count_weight Configures language stats algorithm (see Language stats algorithm). integer 0

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

Name Description Type Default value
hide Hides the languages specified from the card. string (comma-separated values) null
hide_title Hides the title of your card. boolean false
line_height Sets the line height between text. integer 25
hide_progress Hides the progress bar and percentage. boolean false
custom_title Sets a custom title for the card. string WakaTime Stats
layout Switches between two available layouts default & compact. enum default
langs_count Limits the number of languages on the card, defaults to all reported languages. integer null
api_domain Sets a custom API domain for the card, e.g. to use services like Hakatime or Wakapi string wakatime.com
display_format Sets the WakaTime stats display format. Choose time to display time-based stats or percent to show percentages. enum time
disable_animations Disables all animations in the card. boolean false

GitHub Extra Pins

GitHub extra pins allow you to pin more than 6 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=FutureUnreal&repo=github-readme-stats

[![Readme Card](https://github-readme-stats-enhanced.vercel.app/api/pin/?username=yourusername&repo=your-repo-name)](https://github.com/FutureUnreal/github-readme-stats-enhanced)

Demo

Readme Card

Use show_owner query option to include the repo's owner username

Readme Card

GitHub Gist Pins

GitHub gist pins allow you to pin gists in your GitHub profile using a GitHub readme profile.

Usage

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

Endpoint: api/gist?id=bbfce31e0217a3689c8d961a356cb10d

[![Gist Card](https://github-readme-stats-enhanced.vercel.app/api/gist?id=bbfce31e0217a3689c8d961a356cb10d)](https://gist.github.com/Yizack/bbfce31e0217a3689c8d961a356cb10d/)

Demo

Gist Card

Use show_owner query option to include the gist's owner username

Gist Card

Top Languages Card

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

Warning

By default, the language card only shows language data from public repositories. To include language data from private repositories, you should deploy your own instance using your own GitHub API token.

Note

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

Warning

By default, this card only shows language data from your own non-fork repositories and does not depend on who authored the commits. It does not include your contributions to other users'/organizations' repositories.

🆕 Enhanced Feature: Use the include_managed_repos=true parameter to include language statistics from organization repositories you manage (ADMIN/MAINTAIN permissions)!

Warning

Currently, this card only shows data from the top 100 repositories due to GitHub API limitations. For better performance with managed repositories, consider deploying your own instance.

Usage

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

Endpoint: api/top-langs?username=yourusername

[![Top Langs](https://your-instance.vercel.app/api/top-langs/?username=yourusername)](https://github.com/FutureUnreal/github-readme-stats-enhanced)

🆕 Including Managed Repositories

[![Top Langs](https://your-instance.vercel.app/api/top-langs/?username=yourusername&include_managed_repos=true)](https://github.com/FutureUnreal/github-readme-stats-enhanced)

Language stats algorithm

We use the following algorithm to calculate the languages percentages on the language card:

ranking_index = (byte_count ^ size_weight) * (repo_count ^ count_weight)

By default, only the byte count is used for determining the languages percentages shown on the language card (i.e. size_weight=1 and count_weight=0). You can, however, use the &size_weight= and &count_weight= options to weight the language usage calculation. The values must be positive real numbers.

  • &size_weight=1&count_weight=0 - (default) Orders by byte count.
  • &size_weight=0.5&count_weight=0.5 - (recommended) Uses both byte and repo count for ranking
  • &size_weight=0&count_weight=1 - Orders by repo count
![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=FutureUnreal&size_weight=0.5&count_weight=0.5)

Exclude individual repositories

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

![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=FutureUnreal&exclude_repo=github-readme-stats,FutureUnreal.github.io)

Hide individual languages

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

![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=FutureUnreal&hide=javascript,html)

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 20 (inclusive). By default it was set to 5 for normal & donut and 6 for other layouts.

![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=FutureUnreal&langs_count=8)

Compact Language Card Layout

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

![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=FutureUnreal&layout=compact)

Donut Chart Language Card Layout

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

[![Top Langs](https://github-readme-stats-enhanced.vercel.app/api/top-langs/?username=yourusername&layout=donut)](https://github.com/FutureUnreal/github-readme-stats-enhanced)

Donut Vertical Chart Language Card Layout

You can use the &layout=donut-vertical option to change the card design.

[![Top Langs](https://github-readme-stats-enhanced.vercel.app/api/top-langs/?username=yourusername&layout=donut-vertical)](https://github.com/FutureUnreal/github-readme-stats-enhanced)

Pie Chart Language Card Layout

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

[![Top Langs](https://github-readme-stats-enhanced.vercel.app/api/top-langs/?username=yourusername&layout=pie)](https://github.com/FutureUnreal/github-readme-stats-enhanced)

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://github-readme-stats-enhanced.vercel.app/api/top-langs/?username=FutureUnreal&hide_progress=true)

Demo

Top Langs

  • Compact layout

Top Langs

  • Donut Chart layout

Top Langs

  • Donut Vertical Chart layout

Top Langs

  • Pie Chart layout

Top Langs

  • Hidden progress bars

Top Langs

WakaTime Stats Card

Warning

Please be aware that we currently only show data from WakaTime profiles that are public. You therefore have to make sure that BOTH Display code time publicly and Display languages, editors, os, categories publicly are enabled.

Change the ?username= value to your WakaTime username.

[![WakaTime stats](https://github-readme-stats-enhanced.vercel.app/api/wakatime?username=yourusername)](https://github.com/FutureUnreal/github-readme-stats-enhanced)

Demo

Harlok's WakaTime stats

Harlok's WakaTime stats

  • Compact layout

Harlok's WakaTime stats


All Demos

  • Default

FutureUnreal's GitHub stats

  • With icons and theme

FutureUnreal's GitHub stats

Quick Tip (Align The Cards)

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

<a href="https://github.com/FutureUnreal/github-readme-stats-enhanced">
  <img height=200 align="center" src="https://github-readme-stats-enhanced.vercel.app/api?username=yourusername" />
</a>
<a href="https://github.com/FutureUnreal/github-readme-stats-enhanced">
  <img height=200 align="center" src="https://github-readme-stats-enhanced.vercel.app/api/top-langs?username=yourusername&layout=compact&langs_count=8&card_width=320" />
</a>

Quick Tip (Align The 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/FutureUnreal/github-readme-stats-enhanced">
  <img height=200 align="center" src="https://github-readme-stats-enhanced.vercel.app/api?username=FutureUnreal" />
</a>
<a href="https://github.com/FutureUnreal/convoychat">
  <img height=200 align="center" src="https://github-readme-stats-enhanced.vercel.app/api/top-langs?username=FutureUnreal&layout=compact&langs_count=8&card_width=320" />
</a>
<a href="https://github.com/FutureUnreal/github-readme-stats-enhanced">
  <img align="center" src="https://github-readme-stats-enhanced.vercel.app/api/pin/?username=FutureUnreal&repo=github-readme-stats-enhanced" />
</a>
<a href="https://github.com/FutureUnreal/convoychat">
  <img align="center" src="https://github-readme-stats-enhanced.vercel.app/api/pin/?username=FutureUnreal&repo=convoychat" />
</a>
👀 Show example

Deploy on your own

On Vercel

Since the GitHub API only allows 5k requests per hour, we strongly recommend deploying your own instance for the best experience, especially when using the managed repository feature.

Note

If you are on the Pro (i.e. paid) Vercel plan, the maxDuration value found in the vercel.json can be increased when your Vercel instance frequently times out during the card request. You are advised to keep this value lower than 30 seconds to prevent high memory usage.

Deploy to Vercel

🛠️ Step-by-step guide on setting up your own Vercel instance
  1. Go to vercel.com.
  2. Click on Log in.
  3. Sign in with GitHub by pressing Continue with GitHub.
  4. Sign in to GitHub and allow access to all repositories if prompted.
  5. Fork this repo.
  6. Go back to your Vercel dashboard.
  7. To import a project, click the Add New... button and select the Project option.
  8. Click the Continue with GitHub button, search for the required Git Repository and import it by clicking the Import button. Alternatively, you can import a Third-Party Git Repository using the Import Third-Party Git Repository -> link at the bottom of the page.
  9. Create a personal access token (PAT) here and enable the repo and read:org permissions (this allows access to see private repo and user stats, and is required for the managed repository feature).
  10. Add the PAT as an environment variable named PAT_1 (as shown).
  11. Click deploy, and you're good to go. See your domains to use the API!

On other platforms

🛠️ Step-by-step guide for deploying on other platforms
  1. Fork or clone this repo as per your needs
  2. Add express to the dependencies section of package.json
  3. Run npm i if needed (initial setup)
  4. Run node express.js to start the server, or set the entry point to express.js in package.json if you're deploying on a managed service
  5. You're done 🎉

Disable rate limit protections

Github Readme Stats contains several Vercel environment variables that can be used to remove the rate limit protections:

  • CACHE_SECONDS: This environment variable takes precedence over our cache minimum and maximum values and can circumvent these values for self-hosted Vercel instances.

See the Vercel documentation on adding these environment variables to your Vercel instance.

Keep your fork up to date

You can keep your fork, and thus your private Vercel instance up to date with the upstream using GitHub's Sync Fork button. You can also use the pull package created by @wei to automate this process.

🤝 Contributions & Support

Acknowledgments

This project is based on anuraghazra/github-readme-stats. Thanks to the original author for the excellent work!

How to Support

If this project helps you, you can:

  • ⭐ Give the project a Star
  • 🔗 Give proper credit when you use it in your README, linking back to it
  • 🐛 Report bugs or suggest improvements
  • 🔀 Submit Pull Requests to contribute code

Powered by Vercel

Made with ❤️ and JavaScript. Enhanced for better organization repository management.

About

Enhanced version of github-readme-stats with managed organization repositories support

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published