Skip to content

Commit b0b125e

Browse files
rickstaaqwerty541
andauthored
docs: fix broken admonitions (anuraghazra#2957)
* docs: fix broken admonitions This commit ensures that the admonitions are in line with the new GFM specifications (see https://github.com/orgs/community/discussions/16925#discussioncomment-6506860). * dev --------- Co-authored-by: Alexandr <[email protected]>
1 parent 0173e13 commit b0b125e

File tree

4 files changed

+20
-20
lines changed

4 files changed

+20
-20
lines changed

Diff for: .vscode/settings.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
22
"markdown.extension.toc.levels": "1..3",
33
"editor.formatOnSave": true,
4-
"editor.defaultFormatter": "esbenp.prettier-vscode"
4+
"editor.defaultFormatter": "esbenp.prettier-vscode",
55
}

Diff for: CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -40,20 +40,20 @@ _(make sure you already have a [Vercel](https://vercel.com/) account)_
4040
8. Run the command `vercel dev` to start a development server at <https://localhost:3000>.
4141
9. The cards will then be available from this local endpoint (i.e. `https://localhost:3000/api?username=anuraghazra`).
4242

43-
> **Note**
43+
> [!NOTE]\
4444
> 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.
4545
4646
## Themes Contribution
4747

4848
GitHub Readme Stats supports custom theming, and you can also contribute new themes!
4949

50-
> **Note**
50+
> [!NOTE]\
5151
> 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.
5252
53-
> **Note**
53+
> [!NOTE]\
5454
> 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.
5555
56-
> **Note**
56+
> [!NOTE]\
5757
> 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.
5858
5959
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.

Diff for: readme.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ Please visit [this link](https://give.do/fundraisers/stand-beside-the-victims-of
123123

124124
# Important Notice <!-- omit in toc -->
125125

126-
> **Warning**
126+
> [!WARNING]\
127127
> 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).
128128
129129
# GitHub Stats Card
@@ -136,10 +136,10 @@ Change the `?username=` value to your GitHub username.
136136
[![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)
137137
```
138138

139-
> **Warning**
139+
> [!WARNING]\
140140
> 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.
141141
142-
> **Note**
142+
> [!NOTE]\
143143
> 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.
144144
145145
### Hiding individual stats
@@ -294,7 +294,7 @@ You can customize the appearance of your `Stats Card` or `Repo Card` however you
294294
* `locale` - Sets the language in the card *(e.g. cn, de, es, etc.)*. Default: `en`.
295295
* `border_radius` - Corner rounding on the card. Default: `4.5`.
296296

297-
> **Warning**
297+
> [!WARNING]\
298298
> 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.
299299
300300
##### Gradient in bg\_color
@@ -321,7 +321,7 @@ You can provide multiple comma-separated values in the bg\_color option to rende
321321
* `number_format` - Switches between two available formats for displaying the card values `short` (i.e. `6.6k`) and `long` (i.e. `6626`). Default: `short`.
322322
* `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)`.
323323

324-
> **Note**
324+
> [!NOTE]\
325325
> When hide\_rank=`true`, the minimum card width is 270 px + the title length and padding.
326326
327327
#### Repo Card Exclusive Options
@@ -342,7 +342,7 @@ You can provide multiple comma-separated values in the bg\_color option to rende
342342
* `size_weight` - Configures language stats algorithm *(number)* (see [Language stats algorithm](#Language-stats-algorithm)), defaults to 1.
343343
* `count_weight` - Configures language stats algorithm *(number)* (see [Language stats algorithm](#Language-stats-algorithm)), defaults to 0.
344344

345-
> **Warning**
345+
> [!WARNING]\
346346
> Language names should be URI-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding)
347347
> (i.e: `c++` should become `c%2B%2B`, `jupyter notebook` should become `jupyter%20notebook`, etc.) You can use
348348
> [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
388388

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

391-
> **Warning**
391+
> [!WARNING]\
392392
> 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.
393393
394-
> **Note**
394+
> [!NOTE]\
395395
> 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.
396396
397-
> **Warning**
397+
> [!WARNING]\
398398
> 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.
399399
400400
### Usage
@@ -515,7 +515,7 @@ You can use the `&hide_progress=true` option to hide the percentages and the pro
515515

516516
# Wakatime Stats Card
517517

518-
> **Warning**
518+
> [!WARNING]\
519519
> 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.
520520
521521
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
653653

654654
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!
655655

656-
> **Note**
656+
> [!NOTE]\
657657
> 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:.
658658
659-
> **Note**
659+
> [!NOTE]\
660660
> 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.
661661
662662
[![Deploy to Vercel](https://vercel.com/button)](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
685685

686686
## On other platforms
687687

688-
> **Warning**
688+
> [!WARNING]\
689689
> 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.
690690
691691
<details>

Diff for: scripts/preview-theme.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ const FAIL_TEXT = `
2929
const THEME_CONTRIB_GUIDELINES = `
3030
\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).
3131
32-
\r> **Warning**
32+
\r> [!WARNING]\
3333
\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.
3434
35-
\r> **Note**
35+
\r> [!NOTE]\
3636
\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).
3737
`;
3838
const COLOR_PROPS = {

0 commit comments

Comments
 (0)