mirror of
https://github.com/anuraghazra/github-readme-stats.git
synced 2024-12-15 06:04:17 +08:00
772 lines
38 KiB
Markdown
772 lines
38 KiB
Markdown
<p align="center">
|
|
<img width="100px" src="https://res.cloudinary.com/anuraghazra/image/upload/v1594908242/logo_ccswme.svg" align="center" alt="GitHub Readme Stats" />
|
|
<h2 align="center">GitHub Readme Stats</h2>
|
|
<p align="center">Get dynamically generated GitHub stats on your READMEs!</p>
|
|
</p>
|
|
<p align="center">
|
|
<a href="https://github.com/anuraghazra/github-readme-stats/actions">
|
|
<img alt="Tests Passing" src="https://github.com/anuraghazra/github-readme-stats/workflows/Test/badge.svg" />
|
|
</a>
|
|
<a href="https://github.com/anuraghazra/github-readme-stats/graphs/contributors">
|
|
<img alt="GitHub Contributors" src="https://img.shields.io/github/contributors/anuraghazra/github-readme-stats" />
|
|
</a>
|
|
<a href="https://codecov.io/gh/anuraghazra/github-readme-stats">
|
|
<img alt="Tests Coverage" src="https://codecov.io/gh/anuraghazra/github-readme-stats/branch/master/graph/badge.svg" />
|
|
</a>
|
|
<a href="https://github.com/anuraghazra/github-readme-stats/issues">
|
|
<img alt="Issues" src="https://img.shields.io/github/issues/anuraghazra/github-readme-stats?color=0088ff" />
|
|
</a>
|
|
<a href="https://github.com/anuraghazra/github-readme-stats/pulls">
|
|
<img alt="GitHub pull requests" src="https://img.shields.io/github/issues-pr/anuraghazra/github-readme-stats?color=0088ff" />
|
|
</a>
|
|
<a href="https://securityscorecards.dev/viewer/?uri=github.com/anuraghazra/github-readme-stats">
|
|
<img alt="OpenSSF Scorecard" src="https://api.securityscorecards.dev/projects/github.com/anuraghazra/github-readme-stats/badge" />
|
|
</a>
|
|
<br />
|
|
<br />
|
|
<a href="https://a.paddle.com/v2/click/16413/119403?link=1227">
|
|
<img src="https://img.shields.io/badge/Supported%20by-VSCode%20Power%20User%20%E2%86%92-gray.svg?colorA=655BE1&colorB=4F44D6&style=for-the-badge"/>
|
|
</a>
|
|
<a href="https://a.paddle.com/v2/click/16413/119403?link=2345">
|
|
<img src="https://img.shields.io/badge/Supported%20by-Node%20Cli.com%20%E2%86%92-gray.svg?colorA=61c265&colorB=4CAF50&style=for-the-badge"/>
|
|
</a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="#all-demos">View Demo</a>
|
|
·
|
|
<a href="https://github.com/anuraghazra/github-readme-stats/issues/new/choose">Report Bug</a>
|
|
·
|
|
<a href="https://github.com/anuraghazra/github-readme-stats/issues/new/choose">Request Feature</a>
|
|
·
|
|
<a href="https://github.com/anuraghazra/github-readme-stats/discussions/1770">FAQ</a>
|
|
·
|
|
<a href="https://github.com/anuraghazra/github-readme-stats/discussions/new?category=q-a">Ask Question</a>
|
|
</p>
|
|
<p align="center">
|
|
<a href="/docs/readme_fr.md">Français </a>
|
|
·
|
|
<a href="/docs/readme_cn.md">简体中文</a>
|
|
·
|
|
<a href="/docs/readme_es.md">Español</a>
|
|
·
|
|
<a href="/docs/readme_de.md">Deutsch</a>
|
|
·
|
|
<a href="/docs/readme_ja.md">日本語</a>
|
|
·
|
|
<a href="/docs/readme_pt-BR.md">Português Brasileiro</a>
|
|
·
|
|
<a href="/docs/readme_it.md">Italiano</a>
|
|
·
|
|
<a href="/docs/readme_kr.md">한국어</a>
|
|
·
|
|
<a href="/docs/readme_nl.md">Nederlands</a>
|
|
·
|
|
<a href="/docs/readme_np.md">नेपाली</a>
|
|
·
|
|
<a href="/docs/readme_tr.md">Türkçe</a>
|
|
</p>
|
|
</p>
|
|
|
|
<p align="center">Please note that documentation translations may be outdated, try to use english documentation if possible.</p>
|
|
|
|
<p align="center">Love the project? Please consider <a href="https://www.paypal.me/anuraghazra">donating</a> to help it improve!</p>
|
|
|
|
<a href="https://indiafightscorona.giveindia.org">
|
|
<img src="https://cfstatic.give.do/logo.png" alt="Give india logo" width="200" />
|
|
</a>
|
|
|
|
Are you considering supporting the project by donating to me? Please DO NOT!!
|
|
|
|
<img src="https://cfstatic.give.do/910ede2a-7892-43fe-8c8a-dea45e96d950.webp" alt="Picture of Coromandel Express train tragedy" width="35%">
|
|
|
|
India just suffered one of the most devastating train accident and your help will be immensely valuable for the people who were affected by this tragedy.
|
|
|
|
Please visit [this link](https://give.do/fundraisers/stand-beside-the-victims-of-the-coromandel-express-train-tragedy-in-odisha-donate-now) and make a small donation to help the people in need. A small donation goes a long way. :heart:
|
|
|
|
</p>
|
|
|
|
# Features <!-- omit in toc -->
|
|
|
|
- [GitHub Stats Card](#github-stats-card)
|
|
- [Hiding individual stats](#hiding-individual-stats)
|
|
- [Showing additional individual stats](#showing-additional-individual-stats)
|
|
- [Showing icons](#showing-icons)
|
|
- [Themes](#themes)
|
|
- [Customization](#customization)
|
|
- [GitHub Extra Pins](#github-extra-pins)
|
|
- [Usage](#usage)
|
|
- [Demo](#demo)
|
|
- [GitHub Gist Pins](#github-gist-pins)
|
|
- [Usage](#usage-1)
|
|
- [Demo](#demo-1)
|
|
- [Top Languages Card](#top-languages-card)
|
|
- [Usage](#usage-2)
|
|
- [Language stats algorithm](#language-stats-algorithm)
|
|
- [Exclude individual repositories](#exclude-individual-repositories)
|
|
- [Hide individual languages](#hide-individual-languages)
|
|
- [Show more languages](#show-more-languages)
|
|
- [Compact Language Card Layout](#compact-language-card-layout)
|
|
- [Donut Chart Language Card Layout](#donut-chart-language-card-layout)
|
|
- [Donut Vertical Chart Language Card Layout](#donut-vertical-chart-language-card-layout)
|
|
- [Pie Chart Language Card Layout](#pie-chart-language-card-layout)
|
|
- [Hide Progress Bars](#hide-progress-bars)
|
|
- [Demo](#demo-2)
|
|
- [Wakatime Stats Card](#wakatime-stats-card)
|
|
- [Demo](#demo-3)
|
|
- [All Demos](#all-demos)
|
|
- [Quick Tip (Align The Cards)](#quick-tip-align-the-cards)
|
|
- [Deploy on your own](#deploy-on-your-own)
|
|
- [On Vercel](#on-vercel)
|
|
- [:film\_projector: Check Out Step By Step Video Tutorial By @codeSTACKr](#film_projector-check-out-step-by-step-video-tutorial-by-codestackr)
|
|
- [On other platforms](#on-other-platforms)
|
|
- [Disable rate limit protections](#disable-rate-limit-protections)
|
|
- [Keep your fork up to date](#keep-your-fork-up-to-date)
|
|
- [:sparkling\_heart: Support the project](#sparkling_heart-support-the-project)
|
|
|
|
# Important Notice <!-- omit in toc -->
|
|
|
|
> [!IMPORTANT]\
|
|
> Since the GitHub API only [allows 5k requests per hour per user account](https://docs.github.com/en/graphql/overview/resource-limitations), the public Vercel instance hosted on `https://github-readme-stats.vercel.app/api` could possibly hit the rate limiter (see [#1471](https://github.com/anuraghazra/github-readme-stats/issues/1471)). We use caching to prevent this from happening (see https://github.com/anuraghazra/github-readme-stats#common-options). You can turn off these rate limit protections by deploying [your own Vercel instance](#disable-rate-limit-protections).
|
|
|
|
# GitHub Stats Card
|
|
|
|
Copy-paste this into your markdown content, and that is it. Simple!
|
|
|
|
Change the `?username=` value to your GitHub username.
|
|
|
|
```md
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
```
|
|
|
|
> [!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](#deploy-on-your-own) using your own GitHub API token.
|
|
|
|
> [!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](https://wikipedia.org/wiki/Academic_grading_in_Japan) system. The global percentile is calculated as a weighted sum of percentiles for each statistic (number of commits, pull requests, reviews, issues, stars and followers), based on the cumulative distribution function of the [exponential](https://wikipedia.org/wiki/exponential_distribution) and the [log-normal](https://wikipedia.org/wiki/Log-normal_distribution) distributions. The implementation can be investigated at [src/calculateRank.js](./src/calculateRank.js). The circle around the rank shows 100 minus the global percentile.
|
|
|
|
### 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`
|
|
|
|
```md
|
|
|
|
```
|
|
|
|
### 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`
|
|
|
|
```md
|
|
|
|
```
|
|
|
|
### Showing icons
|
|
|
|
To enable icons, you can pass `&show_icons=true` in the query param, like so:
|
|
|
|
```md
|
|
|
|
```
|
|
|
|
### Themes
|
|
|
|
With inbuilt themes, you can customize the look of the card without doing any [manual customization](#customization).
|
|
|
|
Use `&theme=THEME_NAME` parameter like so :
|
|
|
|
```md
|
|
|
|
```
|
|
|
|
#### All inbuilt themes
|
|
|
|
GitHub Readme Stats comes with several built-in themes (e.g. `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 Stats 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, contributing guidelines can be found [here](./CONTRIBUTING.md#themes-contribution).
|
|
|
|
#### Responsive Card Theme
|
|
|
|
[](https://github.com/anuraghazra/github-readme-stats#responsive-card-theme#gh-dark-mode-only)
|
|
[](https://github.com/anuraghazra/github-readme-stats#responsive-card-theme#gh-light-mode-only)
|
|
|
|
Since GitHub will re-upload the cards and serve them from their [CDN](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/about-anonymized-urls), 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:
|
|
|
|
```md
|
|
|
|
```
|
|
|
|
<details>
|
|
<summary>:eyes: Show example</summary>
|
|
|
|
|
|
|
|
</details>
|
|
|
|
##### Add transparent alpha channel to a themes bg\_color
|
|
|
|
You can use the `bg_color` parameter to make any of [the available themes](./themes/README.md) transparent. This is done by setting the `bg_color` to a color with a transparent alpha channel (i.e. `bg_color=00000000`):
|
|
|
|
```md
|
|
|
|
```
|
|
|
|
<details>
|
|
<summary>:eyes: Show example</summary>
|
|
|
|
|
|
|
|
</details>
|
|
|
|
##### Use GitHub's theme context tag
|
|
|
|
You can use [GitHub's theme context](https://github.blog/changelog/2021-11-24-specify-theme-context-for-images-in-markdown/) 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:
|
|
|
|
```md
|
|
[](https://github.com/anuraghazra/github-readme-stats#gh-dark-mode-only)
|
|
[](https://github.com/anuraghazra/github-readme-stats#gh-light-mode-only)
|
|
```
|
|
|
|
<details>
|
|
<summary>:eyes: Show example</summary>
|
|
|
|
[](https://github.com/anuraghazra/github-readme-stats#gh-dark-mode-only)
|
|
[](https://github.com/anuraghazra/github-readme-stats#gh-light-mode-only)
|
|
|
|
</details>
|
|
|
|
##### Use GitHub's new media feature
|
|
|
|
You can use [GitHub's new media feature](https://github.blog/changelog/2022-05-19-specify-theme-context-for-images-in-markdown-beta/) 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.
|
|
|
|
```html
|
|
<picture>
|
|
<source
|
|
srcset="https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=dark"
|
|
media="(prefers-color-scheme: dark)"
|
|
/>
|
|
<source
|
|
srcset="https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true"
|
|
media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)"
|
|
/>
|
|
<img src="https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true" />
|
|
</picture>
|
|
```
|
|
|
|
<details>
|
|
<summary>:eyes: Show example</summary>
|
|
|
|
<picture>
|
|
<source
|
|
srcset="https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=dark"
|
|
media="(prefers-color-scheme: dark)"
|
|
/>
|
|
<source
|
|
srcset="https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true"
|
|
media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)"
|
|
/>
|
|
<img src="https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true" />
|
|
</picture>
|
|
|
|
</details>
|
|
|
|
### Customization
|
|
|
|
You can customize the appearance of all your cards 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](./themes/README.md). Default: `default` theme.
|
|
* `cache_seconds` - Sets the cache header manually *(min: 14400, max: 86400)*. Default: `14400 seconds (4 hours)`.
|
|
* `locale` - Sets the language in the card *(e.g. cn, de, es, etc.)*. Default: `en`.
|
|
* `border_radius` - Corner rounding on the card. Default: `4.5`.
|
|
|
|
> [!WARNING]\
|
|
> We use caching to decrease the load on our servers (see <https://github.com/anuraghazra/github-readme-stats/issues/1471#issuecomment-1271551425>). Our cards have a default cache of 4 hours (14400 seconds). Also, note that the cache is clamped to a minimum of 4 hours and a maximum of 24 hours.
|
|
|
|
##### 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](#hiding-individual-stats) from stats *(Comma-separated values)*. Default: `[] (blank array)`.
|
|
* `hide_title` - *(boolean)*. Default: `false`.
|
|
* `card_width` - Sets the card's width manually *(number)*. Default: `500px (approx.)`.
|
|
* `hide_rank` - *(boolean)* hides the rank and automatically resizes the card width. Default: `false`.
|
|
* `rank_icon` - Shows alternative rank icon (i.e. `github`, `percentile` or `default`). Default: `default`.
|
|
* `show_icons` - *(boolean)*. Default: `false`.
|
|
* `include_all_commits` - Counts total commits instead of just the current year commits *(boolean)*. Default: `false`.
|
|
* `line_height` - Sets the line height between text *(number)*. Default: `25`.
|
|
* `exclude_repo` - Excludes 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` - Uses 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.
|
|
* `number_format` - Switches between two available formats for displaying the card values `short` (i.e. `6.6k`) and `long` (i.e. `6626`). Default: `short`.
|
|
* `show` - Shows [additional items](#showing-additional-individual-stats) on stats card (i.e. `reviews`, `discussions_started`, `discussions_answered`, `prs_merged` or `prs_merged_percentage`) *(Comma-separated values)*. Default: `[] (blank array)`.
|
|
|
|
> [!NOTE]\
|
|
> When hide\_rank=`true`, the minimum card width is 270 px + the title length and padding.
|
|
|
|
#### Repo Card Exclusive Options
|
|
|
|
* `show_owner` - Shows the repo's owner name *(boolean)*. Default: `false`.
|
|
|
|
#### Gist Card Exclusive Options
|
|
|
|
* `show_owner` - Shows the gist's owner name *(boolean)*. Default: `false`.
|
|
|
|
#### Language Card Exclusive Options
|
|
|
|
* `hide` - Hides the languages specified from the card *(Comma-separated values)*. Default: `[] (blank array)`.
|
|
* `hide_title` - *(boolean)*. Default: `false`.
|
|
* `layout` - Switches between five available layouts `normal` & `compact` & `donut` & `donut-vertical` & `pie`. Default: `normal`.
|
|
* `card_width` - Sets the card's width manually *(number)*. Default `300`.
|
|
* `langs_count` - Shows more languages on the card, between 1-20 *(number)*. Default: `5` for `normal` and `donut`, `6` for other layouts.
|
|
* `exclude_repo` - Excludes 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` - Uses the compact layout option, hides percentages, and removes the bars. Default: `false`.
|
|
* `size_weight` - Configures language stats algorithm *(number)* (see [Language stats algorithm](#Language-stats-algorithm)), defaults to 1.
|
|
* `count_weight` - Configures language stats algorithm *(number)* (see [Language stats algorithm](#Language-stats-algorithm)), defaults to 0.
|
|
|
|
> [!WARNING]\
|
|
> Language names should be URI-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding)
|
|
> (i.e: `c++` should become `c%2B%2B`, `jupyter notebook` should become `jupyter%20notebook`, etc.) You can use
|
|
> [urlencoder.org](https://www.urlencoder.org/) to help you do this automatically.
|
|
|
|
#### Wakatime Card Exclusive Options
|
|
|
|
* `hide` - Hides 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` - Switches between two available layouts `default` & `compact`. Default `default`.
|
|
* `langs_count` - Limits the number of languages on the card, defaults to all reported languages *(number)*.
|
|
* `api_domain` - Sets a custom API domain for the card, e.g. to use services like [Hakatime](https://github.com/mujx/hakatime) or [Wakapi](https://github.com/muety/wakapi) *(string)*. Default `Waka API`.
|
|
|
|
***
|
|
|
|
# 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=anuraghazra&repo=github-readme-stats`
|
|
|
|
```md
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
```
|
|
|
|
### Demo
|
|
|
|
|
|
|
|
Use [show\_owner](#repo-card-exclusive-options) query option to include the repo's owner username
|
|
|
|
|
|
|
|
# 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`
|
|
|
|
```md
|
|
[](https://gist.github.com/Yizack/bbfce31e0217a3689c8d961a356cb10d/)
|
|
```
|
|
|
|
### Demo
|
|
|
|
|
|
|
|
Use [show\_owner](#gist-card-exclusive-options) query option to include the gist's owner username
|
|
|
|
|
|
|
|
# Top Languages Card
|
|
|
|
The top languages card shows a GitHub user's most frequently used languages.
|
|
|
|
> [!WARNING]\
|
|
> By default, the language card shows language results only from public repositories. To include languages used in private repositories, you should [deploy your own instance](#deploy-on-your-own) 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 is a new feature of github-readme-stats.
|
|
|
|
> [!WARNING]\
|
|
> This card shows languages usage only inside your own non-forked repositories, not depending from who is the author of the commits. It does not include your contributions into another users/organizations repositories. Currently there are no way to get this data from GitHub API. If you want this behavior to be improved you can support [this feature request](https://github.com/orgs/community/discussions/18230) created by [@rickstaa](https://github.com/rickstaa) inside GitHub Community.
|
|
|
|
### Usage
|
|
|
|
Copy-paste this code into your readme and change the links.
|
|
|
|
Endpoint: `api/top-langs?username=anuraghazra`
|
|
|
|
```md
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
```
|
|
|
|
### Language stats algorithm
|
|
|
|
We use the following algorithm to calculate the languages percentages on the language card:
|
|
|
|
```js
|
|
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. [More details about the algorithm can be found here](https://github.com/anuraghazra/github-readme-stats/issues/1600#issuecomment-1046056305).
|
|
|
|
* `&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
|
|
|
|
```md
|
|
|
|
```
|
|
|
|
### Exclude individual repositories
|
|
|
|
You can use the `&exclude_repo=repo1,repo2` parameter to exclude individual repositories.
|
|
|
|
```md
|
|
|
|
```
|
|
|
|
### Hide individual languages
|
|
|
|
You can use `&hide=language1,language2` parameter to hide individual languages.
|
|
|
|
```md
|
|
|
|
```
|
|
|
|
### 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.
|
|
|
|
```md
|
|
|
|
```
|
|
|
|
### Compact Language Card Layout
|
|
|
|
You can use the `&layout=compact` option to change the card design.
|
|
|
|
```md
|
|
|
|
```
|
|
|
|
### Donut Chart Language Card Layout
|
|
|
|
You can use the `&layout=donut` option to change the card design.
|
|
|
|
```md
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
```
|
|
|
|
### Donut Vertical Chart Language Card Layout
|
|
|
|
You can use the `&layout=donut-vertical` option to change the card design.
|
|
|
|
```md
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
```
|
|
|
|
### Pie Chart Language Card Layout
|
|
|
|
You can use the `&layout=pie` option to change the card design.
|
|
|
|
```md
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
```
|
|
|
|
### 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`).
|
|
|
|
```md
|
|
|
|
```
|
|
|
|
### Demo
|
|
|
|
|
|
|
|
* Compact layout
|
|
|
|
|
|
|
|
* Donut Chart layout
|
|
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
|
|
* Donut Vertical Chart layout
|
|
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
|
|
* Pie Chart layout
|
|
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
|
|
* Hidden progress bars
|
|
|
|
|
|
|
|
# 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](https://wakatime.com) username.
|
|
|
|
```md
|
|
[](https://github.com/anuraghazra/github-readme-stats)
|
|
```
|
|
|
|
### Demo
|
|
|
|
|
|
|
|
|
|
|
|
* Compact layout
|
|
|
|
|
|
|
|
***
|
|
|
|
# All Demos
|
|
|
|
* Default
|
|
|
|
|
|
|
|
* Hiding specific stats
|
|
|
|
|
|
|
|
* Showing additional stats
|
|
|
|
|
|
|
|
* Showing icons
|
|
|
|
|
|
|
|
* Shows Github logo instead rank level
|
|
|
|
|
|
|
|
* Shows user rank percentile instead of rank level
|
|
|
|
|
|
|
|
* Customize Border Color
|
|
|
|
|
|
|
|
* Include All Commits
|
|
|
|
|
|
|
|
* Themes
|
|
|
|
Choose from any of the [default themes](#themes)
|
|
|
|
|
|
|
|
* Gradient
|
|
|
|
|
|
|
|
* Customizing stats card
|
|
|
|
|
|
|
|
* Setting card locale
|
|
|
|
|
|
|
|
* Customizing repo card
|
|
|
|
|
|
|
|
* Gist card
|
|
|
|
|
|
|
|
* Customizing gist card
|
|
|
|
|
|
|
|
* Top languages
|
|
|
|
|
|
|
|
* WakaTime card
|
|
|
|
|
|
|
|
***
|
|
|
|
## 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:
|
|
|
|
```html
|
|
<a href="https://github.com/anuraghazra/github-readme-stats">
|
|
<img height=200 align="center" src="https://github-readme-stats.vercel.app/api?username=anuraghazra" />
|
|
</a>
|
|
<a href="https://github.com/anuraghazra/convoychat">
|
|
<img height=200 align="center" src="https://github-readme-stats.vercel.app/api/top-langs?username=anuraghazra&layout=compact&langs_count=8&card_width=320" />
|
|
</a>
|
|
```
|
|
|
|
```html
|
|
<a href="https://github.com/anuraghazra/github-readme-stats">
|
|
<img align="center" src="https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats" />
|
|
</a>
|
|
<a href="https://github.com/anuraghazra/convoychat">
|
|
<img align="center" src="https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=convoychat" />
|
|
</a>
|
|
```
|
|
|
|
<details>
|
|
<summary>:eyes: Show example</summary>
|
|
|
|
<a href="https://github.com/anuraghazra/github-readme-stats">
|
|
<img height=200 align="center" src="https://github-readme-stats.vercel.app/api?username=anuraghazra" />
|
|
</a>
|
|
<a href="https://github.com/anuraghazra/convoychat">
|
|
<img height=200 align="center" src="https://github-readme-stats.vercel.app/api/top-langs?username=anuraghazra&layout=compact&langs_count=8&card_width=320" />
|
|
</a>
|
|
|
|
***
|
|
|
|
<a href="https://github.com/anuraghazra/github-readme-stats">
|
|
<img align="center" src="https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=github-readme-stats" />
|
|
</a>
|
|
<a href="https://github.com/anuraghazra/convoychat">
|
|
<img align="center" src="https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra&repo=convoychat" />
|
|
</a>
|
|
|
|
</details>
|
|
|
|
# Deploy on your own
|
|
|
|
## On Vercel
|
|
|
|
### :film\_projector: [Check Out Step By Step Video Tutorial By @codeSTACKr](https://youtu.be/n6d4KHSKqGk?t=107)
|
|
|
|
Since the GitHub API only allows 5k requests per hour, my `https://github-readme-stats.vercel.app/api` could possibly hit the rate limiter. If you host it on your own Vercel server, then you do not 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 fewer issues with downtime :grin:.
|
|
|
|
> [!NOTE]\
|
|
> If you are on the [Pro (i.e. paid)](https://vercel.com/pricing) Vercel plan, the [maxDuration](https://vercel.com/docs/concepts/projects/project-configuration#value-definition) value found in the [Vercel.json](https://github.com/anuraghazra/github-readme-stats/blob/master/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.
|
|
|
|
[](https://vercel.com/import/project?template=https://github.com/anuraghazra/github-readme-stats)
|
|
|
|
<details>
|
|
<summary><b>:hammer_and_wrench: Step-by-step guide on setting up your own Vercel instance</b></summary>
|
|
|
|
1. Go to [vercel.com](https://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](https://vercel.com/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](https://github.com/settings/tokens/new) and enable the `repo` and `user` permissions (this allows access to see private repo and user stats).
|
|
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!
|
|
|
|
</details>
|
|
|
|
## On other platforms
|
|
|
|
> [!WARNING]\
|
|
> This way of using GRS is not officially supported and was added to cater to some particular use cases where Vercel could not be used (e.g. [#2341](https://github.com/anuraghazra/github-readme-stats/discussions/2341)). The support for this method, therefore, is limited.
|
|
|
|
<details>
|
|
<summary><b>:hammer_and_wrench: Step-by-step guide for deploying on other platforms</b></summary>
|
|
|
|
1. Fork or clone this repo as per your needs
|
|
2. Add `express` to the dependencies section of `package.json`
|
|
<https://github.com/anuraghazra/github-readme-stats/blob/ba7c2f8b55eac8452e479c8bd38b044d204d0424/package.json#L54-L61>
|
|
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
|
|
<https://github.com/anuraghazra/github-readme-stats/blob/ba7c2f8b55eac8452e479c8bd38b044d204d0424/package.json#L11>
|
|
5. You're done 🎉
|
|
</details>
|
|
|
|
## 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](https://vercel.com/docs/concepts/projects/environment-variables) 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](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork). You can also use the [pull](https://github.com/wei/pull) package created by [@wei](https://github.com/wei) to automate this process.
|
|
|
|
# :sparkling\_heart: Support the project
|
|
|
|
I open-source almost everything I can and try to reply to everyone needing help using these projects. Obviously,
|
|
this takes time. You can use this service for free.
|
|
|
|
However, if you are using this project and are happy with it or just want to encourage me to continue creating stuff, there are a few ways you can do it:
|
|
|
|
* Giving proper credit when you use github-readme-stats on your readme, linking back to it :D
|
|
* Starring and sharing the project :rocket:
|
|
* [](https://www.paypal.me/anuraghazra) - You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
|
|
|
|
Thanks! :heart:
|
|
|
|
***
|
|
|
|
[](https://vercel.com?utm_source=github_readme_stats_team\&utm_campaign=oss)
|
|
|
|
Contributions are welcome! <3
|
|
|
|
Made with :heart: and JavaScript.
|