Skip to content

Commit

Permalink
docs: clean up code and update TOC
Browse files Browse the repository at this point in the history
  • Loading branch information
rickstaa committed Nov 22, 2022
1 parent 522762a commit e437c4d
Showing 1 changed file with 64 additions and 9 deletions.
73 changes: 64 additions & 9 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,12 +80,50 @@ Visit <https://indiafightscorona.giveindia.org> and make a small donation to hel

# Features

- [GitHub Stats Card](#github-stats-card)
- [GitHub Extra Pins](#github-extra-pins)
- [Top Languages Card](#top-languages-card)
- [Wakatime Week Stats](#wakatime-week-stats)
- [Deploy Yourself](#deploy-on-your-own-vercel-instance)
- [Features](#features)
- [GitHub Stats Card](#github-stats-card)
- [Usage](#usage)
- [Common Options](#common-options)
- [Stats Card Exclusive Options](#stats-card-exclusive-options)
- [Examples](#examples)
- [Hiding individual stats](#hiding-individual-stats)
- [Adding private contributions count to total commits count](#adding-private-contributions-count-to-total-commits-count)
- [Showing icons](#showing-icons)
- [Themes](#themes)
- [All inbuilt themes](#all-inbuilt-themes)
- [Responsive Card Theme](#responsive-card-theme)
- [Use the transparent theme](#use-the-transparent-theme)
- [Add transparent alpha channel to a themes bg\_color](#add-transparent-alpha-channel-to-a-themes-bg_color)
- [Use GitHub's theme context tag](#use-githubs-theme-context-tag)
- [Use GitHub's new media feature](#use-githubs-new-media-feature)
- [GitHub Extra Pins](#github-extra-pins)
- [Demo](#demo)
- [Usage](#usage-1)
- [Common Options](#common-options-1)
- [Repo Card Exclusive Options](#repo-card-exclusive-options)
- [Top Languages Card](#top-languages-card)
- [Demo](#demo-1)
- [Compact layout](#compact-layout)
- [Usage](#usage-2)
- [Common Options](#common-options-2)
- [Language Card Exclusive Options](#language-card-exclusive-options)
- [Exclude individual repositories](#exclude-individual-repositories)
- [Hide individual languages](#hide-individual-languages)
- [Show more languages](#show-more-languages)
- [Compact Language Card Layout](#compact-language-card-layout)
- [Wakatime Week Stats](#wakatime-week-stats)
- [Demo](#demo-2)
- [Compact layout](#compact-layout-1)
- [Usage](#usage-3)
- [Common Options](#common-options-3)
- [Wakatime Card Exclusive Options](#wakatime-card-exclusive-options)
- [All Demos](#all-demos)
- [Quick Tip (Align The Repo Cards)](#quick-tip-align-the-repo-cards)
- [Deploy on your own Vercel instance](#deploy-on-your-own-vercel-instance)
- [Step-by-step Video Tutorial By @codeSTACKr](#step-by-step-video-tutorial-by-codestackr)
- [Step-by-step text guide](#step-by-step-text-guide)
- [Keep your fork up to date](#keep-your-fork-up-to-date)
- [:sparkling\_heart: Support the project](#sparkling_heart-support-the-project)

# GitHub Stats Card

Expand Down Expand Up @@ -141,11 +179,15 @@ You can customize the appearance of your `Stats Card` or `Repo Card` however you
> **Note**
> When hide_rank=`true`, the minimum card width is 270 px + the title length and padding.
<details>
<summary><h3>:eyes: Show examples</h3></summary>

### Examples

#### Hiding individual stats

<details>
<summary>:eyes: Show example</summary>


You can pass a query parameter `&hide=` to hide any specific stats with comma-separated values.

> Options: `&hide=stars,commits,prs,issues,contribs`
Expand All @@ -154,8 +196,13 @@ You can pass a query parameter `&hide=` to hide any specific stats with comma-se
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=contribs,prs)
```

</details>

#### Adding private contributions count to total commits count

<details>
<summary>:eyes: Show example</summary>

You can add the count of all your private contributions to the total commits count by using the query parameter `&count_private=true`.

> **Note**
Expand All @@ -167,13 +214,19 @@ You can add the count of all your private contributions to the total commits cou
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&count_private=true)
```

</details>

#### Showing icons

<details>
<summary>:eyes: Show example</summary>

To enable icons, you can pass `show_icons=true` in the query param, like so:

```md
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true)
```

</details>

### Themes
Expand Down Expand Up @@ -505,7 +558,7 @@ By default, GitHub does not lay out the cards side by side. To do that, you can

# Deploy on your own Vercel instance

#### [Check Out Step By Step Video Tutorial By @codeSTACKr](https://youtu.be/n6d4KHSKqGk?t=107)
### [Step-by-step Video Tutorial By @codeSTACKr](https://youtu.be/n6d4KHSKqGk?t=107)

> **Warning**
> If you are on the [hobby (i.e. free)](https://vercel.com/pricing) Vercel plan, please make sure you change the `maxDuration` parameter in the [vercel.json](https://github.com/anuraghazra/github-readme-stats/blob/master/vercel.json) file from `30` to `10` (see [#1416](https://github.com/anuraghazra/github-readme-stats/issues/1416#issuecomment-950275476) for more information).
Expand All @@ -517,8 +570,10 @@ Since the GitHub API only allows 5k requests per hour, my `https://github-readme
[![Deploy to Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/anuraghazra/github-readme-stats)

### Step-by-step text guide

<details>
<summary><b>:hammer_and_wrench: Step-by-step guide on setting up your own Vercel instance</b></summary>
<summary>:eyes: Show steps</summary>

1. Go to [vercel.com](https://vercel.com/).
2. Click on `Log in`.
Expand Down

0 comments on commit e437c4d

Please sign in to comment.