re-organize documentation files
This commit is contained in:
martin-mfg
@@ -0,0 +1,720 @@
|
||||
# Table of Contents
|
||||
- [GitHub Stats Card](#github-stats-card)
|
||||
- [GitHub Extra Pins](#github-extra-pins)
|
||||
- [GitHub Gist Pins](#github-gist-pins)
|
||||
- [Top Languages Card](#top-languages-card)
|
||||
- [WakaTime Stats Card](#wakatime-stats-card)
|
||||
- [All Demos](#all-demos)
|
||||
|
||||
# GitHub Stats Card
|
||||
|
||||
> [!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](https://github.com/anuraghazra/github-readme-stats/blob/master/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,prs_authored,prs_commented,prs_reviewed,issues_authored,issues_commented`
|
||||
|
||||
```md
|
||||
|
||||
```
|
||||
|
||||
### Showing icons
|
||||
|
||||
To enable icons, you can pass `&show_icons=true` in the query param, like so:
|
||||
|
||||
```md
|
||||
|
||||
```
|
||||
|
||||
### Filtering by repository and owner
|
||||
|
||||
To compute your stats for only a specific repository, you can pass a query parameter `&repo=<user_or_organization>/<repository>`. You can also specify a comma-separated list of multiple repositories, e.g. `&repo=userA/repositoryA,organizationB/repositoryB`. And you can select all repositories owned by specific organizations or users by providing a comma-separated list of owners via the `owner` query parameter, e.g. `&owner=userA,organizationB,organizationC`. The `repo` and `owner` filters are supported by the following items: `commits` (when used with `&include_all_commits=true`), `prs_authored`, `prs_commented`, `prs_reviewed`, `issues_authored` and `issues_commented`. Note that most of these items are not displayed by default, but [you can enable them individually](#showing-additional-individual-stats).
|
||||
|
||||
(Some of these mentioned items are similar to other items which are included by default, e.g. `issues_authored` is similar to `issues`. The difference is how these values are fetched - [via GraphQL or via REST API](https://github.com/anuraghazra/github-readme-stats/discussions/1770#number-of-commits-is-incorrect). The default items use GraphQL, but filtering by repository works better via REST API.)
|
||||
|
||||
Alternatively, you can use the `role` parameter to specify a comma-separated list of [roles](https://docs.github.com/en/graphql/reference/enums#repositoryaffiliation). The stats will include all repositories in which the user has the specified role. By default, only repositories where the user is OWNER will be included, but you could e.g. set `&role=OWNER,ORGANIZATION_MEMBER,COLLABORATOR`. The `role` parameter is supported by all items except the following: `commits` (when used with `&include_all_commits=true`), `prs_authored`, `prs_commented`, `prs_reviewed`, `issues_authored` and `issues_commented`.
|
||||
### Showing commits count for specified year
|
||||
|
||||
You can specify a year and fetch only the commits that were made in that year by passing `&commits_year=YYYY` to the parameter.
|
||||
|
||||
```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](../backend/themes/README.md) or checkout the [theme config file](../backend/themes/index.js). 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
|
||||
|
||||
[](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-phi-jet-58.vercel.app/api?username=anuraghazra&show_icons=true&theme=dark"
|
||||
media="(prefers-color-scheme: dark)"
|
||||
/>
|
||||
<source
|
||||
srcset="https://github-readme-stats-phi-jet-58.vercel.app/api?username=anuraghazra&show_icons=true"
|
||||
media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)"
|
||||
/>
|
||||
<img src="https://github-readme-stats-phi-jet-58.vercel.app/api?username=anuraghazra&show_icons=true" />
|
||||
</picture>
|
||||
```
|
||||
|
||||
<details>
|
||||
<summary>:eyes: Show example</summary>
|
||||
|
||||
<picture>
|
||||
<source
|
||||
srcset="https://github-readme-stats-phi-jet-58.vercel.app/api?username=anuraghazra&show_icons=true&theme=dark"
|
||||
media="(prefers-color-scheme: dark)"
|
||||
/>
|
||||
<source
|
||||
srcset="https://github-readme-stats-phi-jet-58.vercel.app/api?username=anuraghazra&show_icons=true"
|
||||
media="(prefers-color-scheme: light), (prefers-color-scheme: no-preference)"
|
||||
/>
|
||||
<img src="https://github-readme-stats-phi-jet-58.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
|
||||
|
||||
| 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](themes/README.md). | 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](#available-locales). | enum | `en` |
|
||||
| `border_radius` | Corner rounding on the card. | number | `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 the following default cache hours: stats card - 24 hours, top languages card - 144 hours (6 days), pin card - 240 hours (10 days), gist card - 48 hours (2 days), and wakatime card - 24 hours. If you want the data on your cards to be updated more often you can [deploy your own instance](deploy.md) and set [environment variable](deploy.md#available-environment-variables) `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:
|
||||
|
||||
<table>
|
||||
<tr><td>
|
||||
|
||||
| Code | Locale |
|
||||
| --- | --- |
|
||||
| `ar` | Arabic |
|
||||
| `az` | Azerbaijani |
|
||||
| `bn` | Bengali |
|
||||
| `bg` | Bulgarian |
|
||||
| `my` | Burmese |
|
||||
| `ca` | Catalan |
|
||||
| `cn` | Chinese |
|
||||
| `zh-tw` | Chinese (Taiwan) |
|
||||
| `cs` | Czech |
|
||||
| `nl` | Dutch |
|
||||
| `en` | English |
|
||||
| `fil` | Filipino |
|
||||
| `fi` | Finnish |
|
||||
| `fr` | French |
|
||||
| `de` | German |
|
||||
| `el` | Greek |
|
||||
|
||||
</td><td>
|
||||
|
||||
| Code | Locale |
|
||||
| --- | --- |
|
||||
| `he` | Hebrew |
|
||||
| `hi` | Hindi |
|
||||
| `hu` | Hungarian |
|
||||
| `id` | Indonesian |
|
||||
| `it` | Italian |
|
||||
| `ja` | Japanese |
|
||||
| `kr` | Korean |
|
||||
| `ml` | Malayalam |
|
||||
| `np` | Nepali |
|
||||
| `no` | Norwegian |
|
||||
| `fa` | Persian (Farsi) |
|
||||
| `pl` | Polish |
|
||||
| `pt-br` | Portuguese (Brazil) |
|
||||
| `pt-pt` | Portuguese (Portugal) |
|
||||
| `ro` | Romanian |
|
||||
|
||||
</td><td>
|
||||
|
||||
| Code | Locale |
|
||||
| --- | --- |
|
||||
| `ru` | Russian |
|
||||
| `sa` | Sanskrit |
|
||||
| `sr` | Serbian (Cyrillic) |
|
||||
| `sr-latn` | Serbian (Latin) |
|
||||
| `sk` | Slovak |
|
||||
| `es` | Spanish |
|
||||
| `sw` | Swahili |
|
||||
| `se` | Swedish |
|
||||
| `ta` | Tamil |
|
||||
| `th` | Thai |
|
||||
| `tr` | Turkish |
|
||||
| `uk-ua` | Ukrainian |
|
||||
| `ur` | Urdu |
|
||||
| `uz` | Uzbek |
|
||||
| `vi` | Vietnamese |
|
||||
|
||||
</td></tr>
|
||||
</table>
|
||||
|
||||
If we don't support your language, please consider contributing! You can find more information about how to do it in our [contributing guidelines](CONTRIBUTING.md#translations-contribution).
|
||||
|
||||
#### Stats Card Exclusive Options
|
||||
|
||||
| Name | Description | Type | Default value |
|
||||
| --- | --- | --- | --- |
|
||||
| `hide` | Hides the [specified items](#hiding-individual-stats) 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. Affects only the count for "Total Stars Earned". | string (comma-separated values) | `null` |
|
||||
| `repo` | Count only stats from the specified repositories. Affects only [certain items](#filtering-by-repository-and-owner). | string (comma-separated values) | `null` |
|
||||
| `owner` | Count only stats from the specified organizations or users. Affects only [certain items](#filtering-by-repository-and-owner). | string (comma-separated values) | `null` |
|
||||
| `role` | Include repositories where the user has one of the specified [roles](https://docs.github.com/en/graphql/reference/enums#repositoryaffiliation) (OWNER, ORGANIZATION_MEMBER, COLLABORATOR). | string (comma-separated values) | `OWNER` |
|
||||
| `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` |
|
||||
| `number_precision` | Enforce the number of digits after the decimal point for `short` number format. Must be an integer between 0 and 2. Will be ignored for `long` number format. | integer (0, 1 or 2) | `null` |
|
||||
| `show` | Shows [additional items](#showing-additional-individual-stats) on stats card (i.e. `reviews`, `discussions_started`, `discussions_answered`, `prs_merged` or `prs_merged_percentage`. And the following, which support the `repo` and `owner` filters: `prs_authored`, `prs_commented`, `prs_reviewed`, `issues_authored` or `issues_commented`). | string (comma-separated values) | `null` |
|
||||
| `commits_year` | Filters and counts only commits made in the specified year. | integer _(YYYY)_ | `<current year> (one year to date)` |
|
||||
|
||||
> [!WARNING]
|
||||
> Custom title should be URI-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding) (i.e: `Anurag's GitHub Stats` should become `Anurag%27s%20GitHub%20Stats`). You can use [urlencoder.org](https://www.urlencoder.org/) to help you do this automatically.
|
||||
|
||||
> [!NOTE]
|
||||
> When hide\_rank=`true`, the minimum card width is 270 px + the title length and padding.
|
||||
|
||||
***
|
||||
|
||||
# GitHub Extra Pins
|
||||
|
||||
GitHub extra pins allow you to pin more than 6 repositories in your profile using a GitHub profile readme.
|
||||
|
||||
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)
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
You can customize the appearance and behavior of the pinned repository card using the [common options](#common-options) and exclusive options listed in the table below.
|
||||
|
||||
| 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` |
|
||||
| `card_width` | Sets the card's width manually. | number | `400px (approx.)` |
|
||||
| `show_icons` | Shows icons near all stats enabled via `show`. | boolean | `true` |
|
||||
| `line_height` | Sets the line height between stats enabled via `show`. | integer | `22` |
|
||||
| `text_bold` | Uses bold text for all stats enabled via `show`. | boolean | `false` |
|
||||
| `number_format` | Switches between two available formats for displaying the numbers for all stats enabled via `show`: `short` (i.e. `6.6k`) and `long` (i.e. `6626`). | enum | `short` |
|
||||
| `show` | Shows [additional items](#showing-additional-individual-stats) on stats card (i.e. `prs_authored`, `prs_commented`, `prs_reviewed`, `issues_authored` or `issues_commented`). | string (comma-separated values) | `null` |
|
||||
|
||||
### Demo
|
||||
|
||||
|
||||
|
||||
Use [show\_owner](#options) query option to include the repo's owner username:
|
||||
|
||||
|
||||
|
||||
Use [show](#options) query option to display the user's contributions to the repository:
|
||||
|
||||
|
||||
|
||||
You can also specify the `repo` parameter in the form `<user_or_organization>/<repository>` to pin a repository from any user or organization, not just your own. This allows you to showcase repositories you contributed to, regardless of ownership.
|
||||
|
||||
|
||||
|
||||
# GitHub Gist Pins
|
||||
|
||||
GitHub gist pins allow you to pin gists in your GitHub profile using a GitHub profile readme.
|
||||
|
||||
### Usage
|
||||
|
||||
Copy-paste this code into your readme and change the links.
|
||||
|
||||
Endpoint: `api/gist?id=bbfce31e0217a3689c8d961a356cb10d`
|
||||
|
||||
```md
|
||||
[](https://gist.github.com/Yizack/bbfce31e0217a3689c8d961a356cb10d/)
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
You can customize the appearance and behavior of the gist card using the [common options](#common-options) and exclusive options listed in the table below.
|
||||
|
||||
| Name | Description | Type | Default value |
|
||||
| --- | --- | --- | --- |
|
||||
| `show_owner` | Shows the gist's owner name. | boolean | `false` |
|
||||
|
||||
### Demo
|
||||
|
||||
|
||||
|
||||
Use [show\_owner](#options-1) query option to include the gist's owner username
|
||||
|
||||
|
||||
|
||||
# Top Languages Card
|
||||
|
||||
The top languages card shows your 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.
|
||||
|
||||
> [!WARNING]
|
||||
> This card shows language usage only inside your own non-forked repositories, not depending on who the author of the commits is. 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.
|
||||
|
||||
> [!WARNING]
|
||||
> Currently this card shows data only about first 100 repositories. This is because GitHub API limitations which cause downtimes of public instances (see [#1471](https://github.com/anuraghazra/github-readme-stats/issues/1471)). In future this behavior will be improved by releasing GitHub action or providing environment variables for user's own instances.
|
||||
|
||||
### 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)
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
You can customize the appearance and behavior of the top languages card using the [common options](#common-options) and exclusive options listed in the table below.
|
||||
|
||||
| Name | Description | Type | Default value |
|
||||
| --- | --- | --- | --- |
|
||||
| `hide` | Hides the [specified languages](#hide-individual-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` |
|
||||
| `role` | Include repositories where the user has one of the specified [roles](https://docs.github.com/en/graphql/reference/enums#repositoryaffiliation) (OWNER, ORGANIZATION_MEMBER, COLLABORATOR). | string (comma-separated values) | `OWNER` |
|
||||
| `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](#language-stats-algorithm)). | integer | `1` |
|
||||
| `count_weight` | Configures language stats algorithm (see [Language stats algorithm](#language-stats-algorithm)). | integer | `0` |
|
||||
| `stats_format` | Switches between two available formats for language's stats `percentages` and `bytes`. | enum | `percentages` |
|
||||
|
||||
> [!WARNING]
|
||||
> Language names and custom title 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`, `Most Used Languages` should become `Most%20Used%20Languages`, etc.) You can use [urlencoder.org](https://www.urlencoder.org/) to help you do this automatically.
|
||||
|
||||
### 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 20 (inclusive). By default it was set to `5` for `normal` & `donut` and `6` for other layouts.
|
||||
|
||||
```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
|
||||
|
||||
```
|
||||
|
||||
### Change format of language's stats
|
||||
|
||||
You can use the `&stats_format=bytes` option to display the stats in bytes instead of percentage.
|
||||
|
||||
```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
|
||||
|
||||
|
||||
|
||||
|
||||
* Display bytes instead of percentage
|
||||
|
||||
|
||||
|
||||
# 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.
|
||||
|
||||
> [!WARNING]
|
||||
> In case you just created a new WakaTime account, then it might take up to 24 hours until your stats will become visible on the WakaTime stats card.
|
||||
|
||||
Change the `?username=` value to your [WakaTime](https://wakatime.com) username.
|
||||
|
||||
```md
|
||||
[](https://github.com/anuraghazra/github-readme-stats)
|
||||
```
|
||||
|
||||
### Options
|
||||
|
||||
You can customize the appearance and behavior of the WakaTime stats card using the [common options](#common-options) and exclusive options listed in the table below.
|
||||
|
||||
| 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` |
|
||||
| `card_width` | Sets the card's width manually. | number | `495` |
|
||||
| `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](https://github.com/mujx/hakatime) or [Wakapi](https://github.com/muety/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` |
|
||||
|
||||
> [!WARNING]
|
||||
> Custom title should be URI-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding) (i.e: `WakaTime Stats` should become `WakaTime%20Stats`). You can use [urlencoder.org](https://www.urlencoder.org/) to help you do this automatically.
|
||||
|
||||
### Demo
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
* Compact layout
|
||||
|
||||
|
||||
|
||||
***
|
||||
|
||||
# All Demos
|
||||
|
||||
* Default
|
||||
|
||||
|
||||
|
||||
* Hiding specific stats
|
||||
|
||||
|
||||
|
||||
* Showing additional stats
|
||||
|
||||
|
||||
|
||||
* Showing stats for a specific repository
|
||||
|
||||
|
||||
|
||||
* Showing stats for a specific organization
|
||||
|
||||
|
||||
|
||||
* 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 such approaches:
|
||||
|
||||
### Stats and top languages cards
|
||||
|
||||
```html
|
||||
<a href="https://github.com/anuraghazra/github-readme-stats">
|
||||
<img height=200 align="center" src="https://github-readme-stats-phi-jet-58.vercel.app/api?username=anuraghazra" />
|
||||
</a>
|
||||
<a href="https://github.com/anuraghazra/convoychat">
|
||||
<img height=200 align="center" src="https://github-readme-stats-phi-jet-58.vercel.app/api/top-langs?username=anuraghazra&layout=compact&langs_count=8&card_width=320" />
|
||||
</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-phi-jet-58.vercel.app/api?username=anuraghazra" />
|
||||
</a>
|
||||
<a href="https://github.com/anuraghazra/convoychat">
|
||||
<img height=200 align="center" src="https://github-readme-stats-phi-jet-58.vercel.app/api/top-langs?username=anuraghazra&layout=compact&langs_count=8&card_width=320" />
|
||||
</a>
|
||||
|
||||
</details>
|
||||
|
||||
### Pinning repositories
|
||||
|
||||
```html
|
||||
<a href="https://github.com/anuraghazra/github-readme-stats">
|
||||
<img align="center" src="https://github-readme-stats-phi-jet-58.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-phi-jet-58.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 align="center" src="https://github-readme-stats-phi-jet-58.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-phi-jet-58.vercel.app/api/pin/?username=anuraghazra&repo=convoychat" />
|
||||
</a>
|
||||
|
||||
</details>
|
||||
|
||||
+132
@@ -0,0 +1,132 @@
|
||||
# Deploy on your own
|
||||
|
||||
Since the GitHub API only allows a limited number of requests per hour, my `https://github-readme-stats-phi-jet-58.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. Also, if you don't want to give my GitHub-Stats-Extended instance access to your private contributions but still want to include these contributions in your stats, you can simply host your own instance.
|
||||
|
||||
## First step: get your Personal Access Token (PAT)
|
||||
|
||||
For deploying your own instance of GitHub Stats Extended, you will need to create a GitHub Personal Access Token (PAT). Below are the steps to create one and the scopes you need to select for both classic and fine-grained tokens.
|
||||
|
||||
Selecting the right scopes for your token is important in case you want to display private contributions on your cards.
|
||||
|
||||
### Classic token
|
||||
|
||||
* Go to [Account -> Settings -> Developer Settings -> Personal access tokens -> Tokens (classic)](https://github.com/settings/tokens).
|
||||
* Click on `Generate new token -> Generate new token (classic)`.
|
||||
* Scopes to select:
|
||||
* repo
|
||||
* read:user
|
||||
* Click on `Generate token` and copy it.
|
||||
|
||||
### Fine-grained token
|
||||
|
||||
> [!WARNING]\
|
||||
> This limits the scope to issues in your repositories and includes only public commits.
|
||||
|
||||
* Go to [Account -> Settings -> Developer Settings -> Personal access tokens -> Fine-grained tokens](https://github.com/settings/tokens).
|
||||
* Click on `Generate new token -> Generate new token`.
|
||||
* Select an expiration date
|
||||
* Select `All repositories`
|
||||
* Scopes to select in `Repository permission`:
|
||||
* Commit statuses: read-only
|
||||
* Contents: read-only
|
||||
* Issues: read-only
|
||||
* Metadata: read-only
|
||||
* Pull requests: read-only
|
||||
* Click on `Generate token` and copy it.
|
||||
|
||||
## On Vercel
|
||||
|
||||
### :film\_projector: [Check Out Step By Step Video Tutorial By @codeSTACKr](https://youtu.be/n6d4KHSKqGk?t=107)
|
||||
|
||||
Click on the deploy button to get started!
|
||||
|
||||
[](https://vercel.com/import/project?template=https://github.com/martin-mfg/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) as described in the [previous section](#first-step-get-your-personal-access-token-pat).
|
||||
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 GitHub-Stats-Extended 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. Move `express` from the devDependencies 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>
|
||||
|
||||
## Available environment variables
|
||||
|
||||
GitHub Readme Stats provides several environment variables that can be used to customize the behavior of your self-hosted instance. These include:
|
||||
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Name</th>
|
||||
<th>Description</th>
|
||||
<th>Supported values</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><code>CACHE_SECONDS</code></td>
|
||||
<td>Sets the cache duration in seconds for the generated cards. This variable takes precedence over the default cache timings for the public instance. If this variable is not set, the default cache duration is 24 hours (86,400 seconds).</td>
|
||||
<td>Any positive integer or <code>0</code> to disable caching</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>WHITELIST</code></td>
|
||||
<td>A comma-separated list of GitHub usernames that are allowed to access your instance. If this variable is not set, all usernames are allowed.</td>
|
||||
<td>Comma-separated GitHub usernames</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>GIST_WHITELIST</code></td>
|
||||
<td>A comma-separated list of GitHub Gist IDs that are allowed to be accessed on your instance. If this variable is not set, all Gist IDs are allowed.</td>
|
||||
<td>Comma-separated GitHub Gist IDs</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>EXCLUDE_REPO</code></td>
|
||||
<td>A comma-separated list of repositories that will be excluded from stats and top languages cards on your instance. This allows repository exclusion without exposing repository names in public URLs. This enhances privacy for self-hosted instances that include private repositories in stats cards.</td>
|
||||
<td>Comma-separated repository names</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><code>FETCH_MULTI_PAGE_STARS</code></td>
|
||||
<td>Enables fetching all starred repositories for accurate star counts, especially for users with more than 100 repositories. This may increase response times and API points usage, so it is limited to 10 fetches - i.e. 1000 repos - on the public instance.</td>
|
||||
<td><code>true</code> or <code>false</code> or a maximum number of fetches</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
See [the Vercel documentation](https://vercel.com/docs/concepts/projects/environment-variables) on adding these environment variables to your Vercel instance.
|
||||
|
||||
> [!WARNING]
|
||||
> Please remember to redeploy your instance after making any changes to the environment variables so that the updates take effect. The changes will not be applied to the previous deployments.
|
||||
|
||||
## 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.
|
||||
@@ -0,0 +1,82 @@
|
||||
# Fork Information
|
||||
|
||||
This project is a fork of [github-readme-stats](https://github.com/anuraghazra/github-readme-stats).
|
||||
|
||||
## Key Differences
|
||||
|
||||
Compared to [github-readme-stats](https://github.com/anuraghazra/github-readme-stats), this project adds the following changes:
|
||||
|
||||
### Frontend for easy, visual configuration of cards
|
||||
|
||||
GitHub-Stats-Extended adds a frontend which allows users to visually configure stats cards. It is hosted at https://monorepo-test-backend-seven.vercel.app/frontend.
|
||||
|
||||
|
||||
|
||||
The frontend is based on [GitHub Trends](https://github.com/avgupta456/github-trends) by @avgupta456.
|
||||
|
||||
### Aggregate stats across organizations
|
||||
To include stars from repos which are not owned by you, but where you are a collaborator or organization member, add `&role=OWNER,ORGANIZATION_MEMBER,COLLABORATOR` to your stats card url. To include such repos in your language stats, you can also add the same parameter to your top languages card url.
|
||||
|
||||
See [here](advanced_documentation.md#filtering-by-repository-and-owner) for full feature documentation.
|
||||
|
||||
The resolution of this most requested feature in github-readme-stats was [originally implemented](https://github.com/anuraghazra/github-readme-stats/issues/1#issuecomment-855681098) by @developStorm.
|
||||
|
||||
### Improved performance and latency
|
||||
|
||||
GitHub-Stats-Extended proactively precomputes and caches cards. This solves [the problem](https://github.com/anuraghazra/github-readme-stats/issues/2603) where cards wouldn't load on the first try. It also gives GitHub-Stats-Extended more time while generating cards in the background, which allows it to fetch more repo data:
|
||||
|
||||
### Multi-page fetching for accurate star counts
|
||||
GitHub-Stats-Extended fetches up to 1000 of your starred repositories to accurately compute your stars count. In github-readme-stats, this is limited to 100 repos because github-readme-stats doesn't have the above-mentioned performance improvements.
|
||||
|
||||
### Private contributions support
|
||||
GitHub-Stats-Extended can include private contributions in your stats cards. You no longer have to deploy your own instance for that. Just log into the [GitHub-Stats-Extended Wizard](https://monorepo-test-backend-seven.vercel.app/frontend) via the "GitHub Private Access" button (or click "Upgrade to Private Access" if already logged in). This will allow GitHub-Stats-Extended to see your private contributions.
|
||||
|
||||
### Display contributions to specific repositories or organizations
|
||||
|
||||
GitHub-Stats-Extended adds the ability to show contribution stats for specific repositories and organizations.
|
||||
|
||||
Especially for regular contributors in open source projects it might make sense to display an overview of their own contributions to these projects on their GitHub profile.
|
||||
|
||||
See [here](advanced_documentation.md#filtering-by-repository-and-owner) for full feature documentation.
|
||||
|
||||
----------
|
||||
|
||||
anuraghazra's contributions to github-readme-stats:
|
||||
|
||||
|
||||
|
||||
Add `&show=prs_authored,prs_commented,prs_reviewed,issues_authored,issues_commented` to your repo card url to display your contributions to the pinned repository.
|
||||
|
||||
----------
|
||||
|
||||
anurag's contributions to razorpay:
|
||||
|
||||
|
||||
|
||||
Add `&repo=userA/repoA,orgB/repoB` or `&owner=userC,orgD` to your profile stats url to filter your contributions by repo or organization. (The screenshot above uses further customization options.)
|
||||
|
||||
### Other
|
||||
GitHub-Stats-Extended adds various other, minor improvements. For example, the repo card now supports the `card_width` parameter.
|
||||
|
||||
## Why This Fork Exists
|
||||
|
||||
[github-readme-stats](https://github.com/anuraghazra/github-readme-stats) is a great project, which unfortunately saw its development slow down in the past years, with [highly requested features](https://github.com/anuraghazra/github-readme-stats/issues/1935) getting delayed for a long time.
|
||||
|
||||
One of the lovely contributors [wrote](https://github.com/anuraghazra/github-readme-stats/pull/3911#issuecomment-3377726545):
|
||||
> I joined the project as collaborator in the middle of 2023 and there was just a few guys in the team while hundreds of PRs, issues and discussions pending to be reviewed.
|
||||
>
|
||||
> The volume is overwhelming for the small team, especially taking into account that right now I'm alone online and working only sometimes when I have a free hours, so it took some time to get to your PR.
|
||||
|
||||
So I decided to implement some of the highly requested features and make the enhanced project available to everyone.
|
||||
|
||||
## Upstream Sync Strategy
|
||||
|
||||
The maintainers of [github-readme-stats](https://github.com/anuraghazra/github-readme-stats) keep their project up to date with dependency upgrades and do occasionally merge some pull requests. I regularly merge the latest upstream changes into this fork to keep it in sync with the upstream repo.
|
||||
|
||||
I also try to structure my own changes in a way that minimizes merge conflicts with the upstream repo. So some of my changes might even be merged back into [github-readme-stats](https://github.com/anuraghazra/github-readme-stats) if the upstream maintainers are interested.
|
||||
|
||||
## Compatibility Notes
|
||||
|
||||
GitHub-Stats-Extended aims to be fully compatible with [github-readme-stats](https://github.com/anuraghazra/github-readme-stats). Generally, additional functionality introduced in this fork has to be explictly enabled via some parameter.
|
||||
|
||||
So you can change an existing stats card url from [github-readme-stats](https://github.com/anuraghazra/github-readme-stats) to GitHub-Stats-Extended simply by changing the domain from `github-readme-stats.vercel.app` to `github-readme-stats-phi-jet-58.vercel.app`. The card will look the same.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 105 KiB |
Reference in New Issue
Block a user