You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -40,20 +40,20 @@ _(make sure you already have a [Vercel](https://vercel.com/) account)_
40
40
8. Run the command `vercel dev` to start a development server at <https://localhost:3000>.
41
41
9. The cards will then be available from this local endpoint (i.e. `https://localhost:3000/api?username=anuraghazra`).
42
42
43
-
> **Note**
43
+
> [!NOTE]\
44
44
> You can debug the package code in [Vscode](https://code.visualstudio.com/) by using the [Node.js: Attach to process](https://code.visualstudio.com/docs/nodejs/nodejs-debugging#_setting-up-an-attach-configuration) debug option. You can also debug any tests using the [VSCode Jest extension](https://marketplace.visualstudio.com/items?itemName=Orta.vscode-jest). For more information, see https://github.com/jest-community/vscode-jest/issues/912.
45
45
46
46
## Themes Contribution
47
47
48
48
GitHub Readme Stats supports custom theming, and you can also contribute new themes!
49
49
50
-
> **Note**
50
+
> [!NOTE]\
51
51
> If you are contributing your theme just because you are using it personally, then you can [customize the looks](./readme.md#customization) of your card with URL params instead.
52
52
53
-
> **Note**
53
+
> [!NOTE]\
54
54
> Keep in mind that we already have a vast collection of different themes. To keep their number manageable, we began to add only themes supported by the community. Your pull request with theme addition will be merged once we get enough positive feedback from the community in the form of thumbs up (see [#1935](https://github.com/anuraghazra/github-readme-stats/issues/1935#top-themes-prs)). Remember that you can also support themes of other contributors that you liked to speed up their merge.
55
55
56
-
> **Note**
56
+
> [!NOTE]\
57
57
> Before submitting pull request, please make sure that your theme pass WCAG 2.0 level AA constrast ration test. You can use [this tool](https://webaim.org/resources/contrastchecker/) to check it.
58
58
59
59
To contribute your theme you need to edit the [themes/index.js](./themes/index.js) file and add it at the end of the file.
> 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).
128
128
129
129
# GitHub Stats Card
@@ -136,10 +136,10 @@ Change the `?username=` value to your GitHub username.
> 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.
141
141
142
-
> **Note**
142
+
> [!NOTE]\
143
143
> 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.
144
144
145
145
### Hiding individual stats
@@ -294,7 +294,7 @@ You can customize the appearance of your `Stats Card` or `Repo Card` however you
294
294
*`locale` - Sets the language in the card *(e.g. cn, de, es, etc.)*. Default: `en`.
295
295
*`border_radius` - Corner rounding on the card. Default: `4.5`.
296
296
297
-
> **Warning**
297
+
> [!WARNING]\
298
298
> 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.
299
299
300
300
##### Gradient in bg\_color
@@ -321,7 +321,7 @@ You can provide multiple comma-separated values in the bg\_color option to rende
321
321
*`number_format` - Switches between two available formats for displaying the card values `short` (i.e. `6.6k`) and `long` (i.e. `6626`). Default: `short`.
322
322
*`show` - Shows [additional items](#showing-additional-individual-stats) on stats card (i.e. `reviews`, `discussions_started` or `discussions_answered`) *(Comma-separated values)*. Default: `[] (blank array)`.
323
323
324
-
> **Note**
324
+
> [!NOTE]\
325
325
> When hide\_rank=`true`, the minimum card width is 270 px + the title length and padding.
326
326
327
327
#### Repo Card Exclusive Options
@@ -342,7 +342,7 @@ You can provide multiple comma-separated values in the bg\_color option to rende
342
342
*`size_weight` - Configures language stats algorithm *(number)* (see [Language stats algorithm](#Language-stats-algorithm)), defaults to 1.
343
343
*`count_weight` - Configures language stats algorithm *(number)* (see [Language stats algorithm](#Language-stats-algorithm)), defaults to 0.
344
344
345
-
> **Warning**
345
+
> [!WARNING]\
346
346
> Language names should be URI-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding)
347
347
> (i.e: `c++` should become `c%2B%2B`, `jupyter notebook` should become `jupyter%20notebook`, etc.) You can use
348
348
> [urlencoder.org](https://www.urlencoder.org/) to help you do this automatically.
@@ -388,13 +388,13 @@ Use [show\_owner](#repo-card-exclusive-options) query option to include the repo
388
388
389
389
The top languages card shows a GitHub user's most frequently used languages.
390
390
391
-
> **Warning**
391
+
> [!WARNING]\
392
392
> 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.
393
393
394
-
> **Note**
394
+
> [!NOTE]\
395
395
> 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.
396
396
397
-
> **Warning**
397
+
> [!WARNING]\
398
398
> 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.
399
399
400
400
### Usage
@@ -515,7 +515,7 @@ You can use the `&hide_progress=true` option to hide the percentages and the pro
515
515
516
516
# Wakatime Stats Card
517
517
518
-
> **Warning**
518
+
> [!WARNING]\
519
519
> 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.
520
520
521
521
Change the `?username=` value to your [Wakatime](https://wakatime.com) username.
@@ -653,10 +653,10 @@ By default, GitHub does not lay out the cards side by side. To do that, you can
653
653
654
654
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!
655
655
656
-
> **Note**
656
+
> [!NOTE]\
657
657
> 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:.
658
658
659
-
> **Note**
659
+
> [!NOTE]\
660
660
> 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.
661
661
662
662
[](https://vercel.com/import/project?template=https://github.com/anuraghazra/github-readme-stats)
@@ -685,7 +685,7 @@ Since the GitHub API only allows 5k requests per hour, my `https://github-readme
685
685
686
686
## On other platforms
687
687
688
-
> **Warning**
688
+
> [!WARNING]\
689
689
> 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.
Copy file name to clipboardExpand all lines: scripts/preview-theme.js
+2-2
Original file line number
Diff line number
Diff line change
@@ -29,10 +29,10 @@ const FAIL_TEXT = `
29
29
constTHEME_CONTRIB_GUIDELINES=`
30
30
\rHi, thanks for the theme contribution. Please read our theme [contribution guidelines](https://github.com/anuraghazra/github-readme-stats/blob/master/CONTRIBUTING.md#themes-contribution).
31
31
32
-
\r> **Warning**
32
+
\r> [!WARNING]\
33
33
\r> Keep in mind that we already have a vast collection of different themes. To keep their number manageable, we began to add only themes supported by the community. Your pull request with theme addition will be merged once we get enough positive feedback from the community in the form of thumbs up (see [#1935](https://github.com/anuraghazra/github-readme-stats/issues/1935#top-themes-prs)). Remember that you can also support themes of other contributors that you liked to speed up their merge.
34
34
35
-
\r> **Note**
35
+
\r> [!NOTE]\
36
36
\r> Also, note that if this theme is exclusively for your personal use, then instead of adding it to our theme collection, you can use card [customization options](https://github.com/anuraghazra/github-readme-stats#customization).
0 commit comments