Skip to content

Commit e437c4d

Browse files
committed
docs: clean up code and update TOC
1 parent 522762a commit e437c4d

File tree

1 file changed

+64
-9
lines changed

1 file changed

+64
-9
lines changed

readme.md

Lines changed: 64 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -80,12 +80,50 @@ Visit <https://indiafightscorona.giveindia.org> and make a small donation to hel
8080

8181
# Features
8282

83-
- [GitHub Stats Card](#github-stats-card)
84-
- [GitHub Extra Pins](#github-extra-pins)
85-
- [Top Languages Card](#top-languages-card)
86-
- [Wakatime Week Stats](#wakatime-week-stats)
87-
- [Deploy Yourself](#deploy-on-your-own-vercel-instance)
83+
- [Features](#features)
84+
- [GitHub Stats Card](#github-stats-card)
85+
- [Usage](#usage)
86+
- [Common Options](#common-options)
87+
- [Stats Card Exclusive Options](#stats-card-exclusive-options)
88+
- [Examples](#examples)
89+
- [Hiding individual stats](#hiding-individual-stats)
90+
- [Adding private contributions count to total commits count](#adding-private-contributions-count-to-total-commits-count)
91+
- [Showing icons](#showing-icons)
92+
- [Themes](#themes)
93+
- [All inbuilt themes](#all-inbuilt-themes)
94+
- [Responsive Card Theme](#responsive-card-theme)
95+
- [Use the transparent theme](#use-the-transparent-theme)
96+
- [Add transparent alpha channel to a themes bg\_color](#add-transparent-alpha-channel-to-a-themes-bg_color)
97+
- [Use GitHub's theme context tag](#use-githubs-theme-context-tag)
98+
- [Use GitHub's new media feature](#use-githubs-new-media-feature)
99+
- [GitHub Extra Pins](#github-extra-pins)
100+
- [Demo](#demo)
101+
- [Usage](#usage-1)
102+
- [Common Options](#common-options-1)
103+
- [Repo Card Exclusive Options](#repo-card-exclusive-options)
104+
- [Top Languages Card](#top-languages-card)
105+
- [Demo](#demo-1)
106+
- [Compact layout](#compact-layout)
107+
- [Usage](#usage-2)
108+
- [Common Options](#common-options-2)
109+
- [Language Card Exclusive Options](#language-card-exclusive-options)
110+
- [Exclude individual repositories](#exclude-individual-repositories)
111+
- [Hide individual languages](#hide-individual-languages)
112+
- [Show more languages](#show-more-languages)
113+
- [Compact Language Card Layout](#compact-language-card-layout)
114+
- [Wakatime Week Stats](#wakatime-week-stats)
115+
- [Demo](#demo-2)
116+
- [Compact layout](#compact-layout-1)
117+
- [Usage](#usage-3)
118+
- [Common Options](#common-options-3)
119+
- [Wakatime Card Exclusive Options](#wakatime-card-exclusive-options)
120+
- [All Demos](#all-demos)
121+
- [Quick Tip (Align The Repo Cards)](#quick-tip-align-the-repo-cards)
122+
- [Deploy on your own Vercel instance](#deploy-on-your-own-vercel-instance)
123+
- [Step-by-step Video Tutorial By @codeSTACKr](#step-by-step-video-tutorial-by-codestackr)
124+
- [Step-by-step text guide](#step-by-step-text-guide)
88125
- [Keep your fork up to date](#keep-your-fork-up-to-date)
126+
- [:sparkling\_heart: Support the project](#sparkling_heart-support-the-project)
89127

90128
# GitHub Stats Card
91129

@@ -141,11 +179,15 @@ You can customize the appearance of your `Stats Card` or `Repo Card` however you
141179
> **Note**
142180
> When hide_rank=`true`, the minimum card width is 270 px + the title length and padding.
143181
144-
<details>
145-
<summary><h3>:eyes: Show examples</h3></summary>
182+
183+
### Examples
146184

147185
#### Hiding individual stats
148186

187+
<details>
188+
<summary>:eyes: Show example</summary>
189+
190+
149191
You can pass a query parameter `&hide=` to hide any specific stats with comma-separated values.
150192

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

199+
</details>
200+
157201
#### Adding private contributions count to total commits count
158202

203+
<details>
204+
<summary>:eyes: Show example</summary>
205+
159206
You can add the count of all your private contributions to the total commits count by using the query parameter `&count_private=true`.
160207

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

217+
</details>
218+
170219
#### Showing icons
171220

221+
<details>
222+
<summary>:eyes: Show example</summary>
223+
172224
To enable icons, you can pass `show_icons=true` in the query param, like so:
173225

174226
```md
175227
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true)
176228
```
229+
177230
</details>
178231

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

506559
# Deploy on your own Vercel instance
507560

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

510563
> **Warning**
511564
> 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).
@@ -517,8 +570,10 @@ Since the GitHub API only allows 5k requests per hour, my `https://github-readme
517570
518571
[![Deploy to Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/anuraghazra/github-readme-stats)
519572

573+
### Step-by-step text guide
574+
520575
<details>
521-
<summary><b>:hammer_and_wrench: Step-by-step guide on setting up your own Vercel instance</b></summary>
576+
<summary>:eyes: Show steps</summary>
522577

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

0 commit comments

Comments
 (0)