Skip to content

Commit

Permalink
Docs: fixed table of contents aligment (anuraghazra#2795)
Browse files Browse the repository at this point in the history
* Fixed table of contents aligment inside README

* dev

* docs: decrease toc depth

---------

Co-authored-by: rickstaa <[email protected]>
  • Loading branch information
2 people authored and jacobbexten committed Nov 6, 2024
1 parent cdd70d8 commit f261887
Showing 1 changed file with 18 additions and 17 deletions.
35 changes: 18 additions & 17 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,14 +106,15 @@ Please visit [this link](https://give.do/fundraisers/stand-beside-the-victims-of
- [Demo](#demo-1)
- [Wakatime Week Stats](#wakatime-week-stats)
- [Demo](#demo-2)
- [All Demos](#all-demos)
- [Quick Tip (Align The Repo Cards)](#quick-tip-align-the-repo-cards)
- [Deploy on your own](#deploy-on-your-own)
- [On Vercel](#on-vercel)
- [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)
- [All Demos](#all-demos)
- [Quick Tip (Align The Repo Cards)](#quick-tip-align-the-repo-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 -->

Expand Down Expand Up @@ -519,7 +520,7 @@ Change the `?username=` value to your [Wakatime](https://wakatime.com) username.

* * *

### All Demos
# All Demos

- Default

Expand Down Expand Up @@ -577,7 +578,7 @@ Choose from any of the [default themes](#themes)

* * *

### Quick Tip (Align The Repo Cards)
## Quick Tip (Align The Repo Cards)

By default, GitHub does not lay out the cards side by side. To do that, you can use this approach:

Expand All @@ -590,11 +591,11 @@ By default, GitHub does not lay out the cards side by side. To do that, you can
</a>
```

## Deploy on your own
# Deploy on your own

### On Vercel
## On Vercel

#### :film_projector: [Check Out Step By Step Video Tutorial By @codeSTACKr](https://youtu.be/n6d4KHSKqGk?t=107)
### :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!

Expand Down Expand Up @@ -628,7 +629,7 @@ Since the GitHub API only allows 5k requests per hour, my `https://github-readme

</details>

### On other platforms
## 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). The support for this method, therefore, is limited.
Expand All @@ -645,19 +646,19 @@ Since the GitHub API only allows 5k requests per hour, my `https://github-readme
5. You're done 🎉
</details>

### Disable rate limit protections
## 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
## 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
# :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.
Expand Down

0 comments on commit f261887

Please sign in to comment.