Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added Go to top feature to Readme.md #3999

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 66 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<h1 id="top1">Readme page1</h1>
<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>
Expand Down Expand Up @@ -85,21 +86,28 @@ Please visit [this link](https://give.do/fundraisers/stand-beside-the-victims-of

# Features <!-- omit in toc -->

- [Go to Top](#go-to-top)
- [GitHub Stats Card](#github-stats-card)
- [Go to Top](#go-to-top-1)
- [Hiding individual stats](#hiding-individual-stats)
- [Showing additional individual stats](#showing-additional-individual-stats)
- [Showing icons](#showing-icons)
- [Themes](#themes)
- [Go to Top](#go-to-top-2)
- [Go to Top](#go-to-top-3)
- [Customization](#customization)
- [Go to Top](#go-to-top-4)
- [GitHub Extra Pins](#github-extra-pins)
- [Usage](#usage)
- [Demo](#demo)
- [Go to Top](#go-to-top-5)
- [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)
- [Go to Top](#go-to-top-6)
- [Exclude individual repositories](#exclude-individual-repositories)
- [Hide individual languages](#hide-individual-languages)
- [Show more languages](#show-more-languages)
Expand All @@ -108,18 +116,30 @@ Please visit [this link](https://give.do/fundraisers/stand-beside-the-victims-of
- [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)
- [Go to Top](#go-to-top-7)
- [Demo](#demo-2)
- [Go to Top](#go-to-top-8)
- [WakaTime Stats Card](#wakatime-stats-card)
- [Demo](#demo-3)
- [Go to Top](#go-to-top-9)
- [All Demos](#all-demos)
- [Go to Top](#go-to-top-10)
- [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)
- [Go to Top](#go-to-top-11)
- [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)
- [Go to Top](#go-to-top-12)
- [:sparkling\_heart: Support the project](#sparkling_heart-support-the-project)
- [Go to Top](#go-to-top-13)


# [Go to Top](#top1)

<h1 id="top2">Readme page2</h1>

# Important Notices <!-- omit in toc -->

Expand Down Expand Up @@ -147,6 +167,10 @@ Change the `?username=` value to your GitHub username.
> [!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.

# [Go to Top](#top2)

<h1 id="top3">Readme page3</h1>

### Hiding individual stats

You can pass a query parameter `&hide=` to hide any specific stats with comma-separated values.
Expand Down Expand Up @@ -193,6 +217,11 @@ GitHub Readme Stats comes with several built-in themes (e.g. `dark`, `radical`,

You can look at a preview for [all available themes](themes/README.md) or checkout the [theme config file](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.


# [Go to Top](#top3)

<h1 id="top4">Readme page4</h1>

#### Responsive Card Theme

[![Anurag's GitHub stats-Dark](https://github-readme-stats.vercel.app/api?username=anuraghazra\&show_icons=true\&theme=dark#gh-dark-mode-only)](https://github.com/anuraghazra/github-readme-stats#responsive-card-theme#gh-dark-mode-only)
Expand Down Expand Up @@ -282,6 +311,11 @@ You can use [GitHub's new media feature](https://github.blog/changelog/2022-05-1

</details>


# [Go to Top](#top4)

<h1 id="top5">Readme page5</h1>

### Customization

You can customize the appearance of all your cards however you wish with URL parameters.
Expand Down Expand Up @@ -438,6 +472,11 @@ If we don't support your language, please consider contributing! You can find mo

***

# [Go to Top](#top5)

<h1 id="top6">Readme page6</h1>


# GitHub Extra Pins

GitHub extra pins allow you to pin more than 6 repositories in your profile using a GitHub readme profile.
Expand All @@ -462,6 +501,10 @@ Use [show\_owner](#repo-card-exclusive-options) query option to include the repo

![Readme Card](https://github-readme-stats.vercel.app/api/pin/?username=anuraghazra\&repo=github-readme-stats\&show_owner=true)

# [Go to Top](#top6)

<h1 id="top7">Readme page7</h1>

# GitHub Gist Pins

GitHub gist pins allow you to pin gists in your GitHub profile using a GitHub readme profile.
Expand Down Expand Up @@ -528,6 +571,10 @@ By default, only the byte count is used for determining the languages percentage
![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&size_weight=0.5&count_weight=0.5)
```

# [Go to Top](#top7)

<h1 id="top8">Readme page8</h1>

### Exclude individual repositories

You can use the `&exclude_repo=repo1,repo2` parameter to exclude individual repositories.
Expand Down Expand Up @@ -591,7 +638,9 @@ You can use the `&hide_progress=true` option to hide the percentages and the pro
```md
![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&hide_progress=true)
```
# [Go to Top](#top8)

<h1 id="top9">Readme page9</h1>
### Demo

![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra)
Expand All @@ -616,6 +665,9 @@ You can use the `&hide_progress=true` option to hide the percentages and the pro

![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra\&hide_progress=true)

# [Go to Top](#top9)

<h1 id="top10">Readme page10</h1>
# WakaTime Stats Card

> [!WARNING]\
Expand All @@ -639,6 +691,9 @@ Change the `?username=` value to your [WakaTime](https://wakatime.com) username.

***

# [Go to Top](#top10)

<h1 id="top11">Readme page11</h1>
# All Demos

* Default
Expand Down Expand Up @@ -713,6 +768,9 @@ Choose from any of the [default themes](#themes)

***

# [Go to Top](#top11)

<h1 id="top12">Readme page12</h1>
## 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:
Expand Down Expand Up @@ -794,6 +852,10 @@ Since the GitHub API only allows 5k requests per hour, my `https://github-readme

</details>


# [Go to Top](#top12)

<h1 id="top13">Readme page13</h1>
## On other platforms

> [!WARNING]\
Expand Down Expand Up @@ -823,6 +885,9 @@ See [the Vercel documentation](https://vercel.com/docs/concepts/projects/environ

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.

# [Go to Top](#top13)

<h1 id="top14">Readme page14</h1>
# :sparkling\_heart: Support the project

I open-source almost everything I can and try to reply to everyone needing help using these projects. Obviously,
Expand All @@ -843,3 +908,4 @@ Thanks! :heart:
Contributions are welcome! <3

Made with :heart: and JavaScript.
# [Go to Top](#top14)