Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitc2c984a

Browse files
committed
docs: format readme
1 parent2faf9c5 commitc2c984a

File tree

1 file changed

+94
-98
lines changed

1 file changed

+94
-98
lines changed

‎readme.md

Lines changed: 94 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,6 @@
6161
</p>
6262
<palign="center">Love the project? Please consider <ahref="https://www.paypal.me/anuraghazra">donating</a> to help it improve!
6363

64-
6564
<p>
6665
<ahref="https://indiafightscorona.giveindia.org">
6766
<imgsrc="https://cdn.givind.org/static/images/giveindia-logo-v2.jpg"alt="Give india logo"width="200" />
@@ -72,25 +71,25 @@ Are you considering supporting the project by donating? Please DON'T!!
7271
Instead, Help India fight the 2nd deadly wave of COVID-19.
7372
Thousands of people are dying in India because of a lack of Oxygen & also COVID-related infrastructure.
7473

75-
Visit[https://indiafightscorona.giveindia.org](https://indiafightscorona.giveindia.org) and make a small donation to help us fight COVID and overcome this crisis.
74+
Visit<https://indiafightscorona.giveindia.org> and make a small donation to help us fight COVID and overcome this crisis.
7675
A small donation goes a long way.:heart:
77-
</p>
7876

77+
</p>
7978

8079
#Features
8180

82-
-[GitHub Stats Card](#github-stats-card)
83-
-[GitHub Extra Pins](#github-extra-pins)
84-
-[Top Languages Card](#top-languages-card)
85-
-[Wakatime Week Stats](#wakatime-week-stats)
86-
-[Themes](#themes)
87-
-[Customization](#customization)
88-
-[Common Options](#common-options)
89-
-[Stats Card Exclusive Options](#stats-card-exclusive-options)
90-
-[Repo Card Exclusive Options](#repo-card-exclusive-options)
91-
-[Language Card Exclusive Options](#language-card-exclusive-options)
92-
-[Wakatime Card Exclusive Option](#wakatime-card-exclusive-options)
93-
-[Deploy Yourself](#deploy-on-your-own-vercel-instance)
81+
-[GitHub Stats Card](#github-stats-card)
82+
-[GitHub Extra Pins](#github-extra-pins)
83+
-[Top Languages Card](#top-languages-card)
84+
-[Wakatime Week Stats](#wakatime-week-stats)
85+
-[Themes](#themes)
86+
-[Customization](#customization)
87+
-[Common Options](#common-options)
88+
-[Stats Card Exclusive Options](#stats-card-exclusive-options)
89+
-[Repo Card Exclusive Options](#repo-card-exclusive-options)
90+
-[Language Card Exclusive Options](#language-card-exclusive-options)
91+
-[Wakatime Card Exclusive Option](#wakatime-card-exclusive-options)
92+
-[Deploy Yourself](#deploy-on-your-own-vercel-instance)
9493

9594
#GitHub Stats Card
9695

@@ -160,60 +159,58 @@ You can customize the appearance of your `Stats Card` or `Repo Card` however you
160159

161160
####Common Options:
162161

163-
-`title_color` - Card's title color_(hex color)_. Default:`2f80ed`.
164-
-`text_color` - Body text color_(hex color)_. Default:`434d58`.
165-
-`icon_color` - Icons color if available_(hex color)_. Default:`4c71f2`.
166-
-`border_color` - Card's border color_(hex color)_. Default:`e4e2e2` (Does not apply when`hide_border` is enabled).
167-
-`bg_color` - Card's background color_(hex color)_**or** a gradient in the form of_angle,start,end_. Default:`fffefe`
168-
-`hide_border` - Hides the card's border_(boolean)_. Default:`false`
169-
-`theme` - name of the theme, choose from[all available themes](./themes/README.md). Default:`default` theme.
170-
-`cache_seconds` - set the cache header manually_(min: 7200, max: 86400)_. Default:`14400 seconds (4 hours)`.
171-
-`locale` - set the language in the card_(e.g. cn, de, es, etc.)_. Default:`en`.
172-
-`border_radius` - Corner rounding on the card. Default:`4.5`.
162+
-`title_color` - Card's title color_(hex color)_. Default:`2f80ed`.
163+
-`text_color` - Body text color_(hex color)_. Default:`434d58`.
164+
-`icon_color` - Icons color if available_(hex color)_. Default:`4c71f2`.
165+
-`border_color` - Card's border color_(hex color)_. Default:`e4e2e2` (Does not apply when`hide_border` is enabled).
166+
-`bg_color` - Card's background color_(hex color)_**or** a gradient in the form of_angle,start,end_. Default:`fffefe`
167+
-`hide_border` - Hides the card's border_(boolean)_. Default:`false`
168+
-`theme` - name of the theme, choose from[all available themes](./themes/README.md). Default:`default` theme.
169+
-`cache_seconds` - set the cache header manually_(min: 7200, max: 86400)_. Default:`14400 seconds (4 hours)`.
170+
-`locale` - set the language in the card_(e.g. cn, de, es, etc.)_. Default:`en`.
171+
-`border_radius` - Corner rounding on the card. Default:`4.5`.
173172

174173
>Note: The minimum of cache_seconds is currently 4 hours as a temporary fix for PATs exhaustion.
175174
176175
#####Gradient in bg_color
177176

178177
You can provide multiple comma-separated values in the bg_color option to render a gradient, with the following format:
179178

180-
```
181-
&bg_color=DEG,COLOR1,COLOR2,COLOR3...COLOR10
182-
```
179+
&bg_color=DEG,COLOR1,COLOR2,COLOR3...COLOR10
183180

184181
>Note on cache: Repo cards have a default cache of 4 hours (14400 seconds) if the fork count & star count is less than 1k, otherwise, it's 2 hours (7200 seconds). Also, note that the cache is clamped to a minimum of 2 hours and a maximum of 24 hours.
185182
186183
####Stats Card Exclusive Options:
187184

188-
-`hide` - Hides the[specified items](#hiding-individual-stats) from stats_(Comma-separated values)_. Default:`[] (blank array)`.
189-
-`hide_title` -_(boolean)_. Default:`false`.
190-
-`card_width` - Set the card's width manually_(number)_. Default:`500px (approx.)`.
191-
-`hide_rank` -_(boolean)_ hides the rank and automatically resizes the card width. Default:`false`.
192-
-`show_icons` -_(boolean)_. Default:`false`.
193-
-`include_all_commits` - Count total commits instead of just the current year commits_(boolean)_. Default:`false`.
194-
-`count_private` - Count private commits_(boolean)_. Default:`false`.
195-
-`line_height` - Sets the line-height between text_(number)_. Default:`25`.
196-
-`exclude_repo` - Exclude stars from specified repositories_(Comma-separated values)_. Default:`[] (blank array)`.
197-
-`custom_title` - Sets a custom title for the card. Default:`<username> Github Stats`.
198-
-`text_bold` - Use bold text_(boolean)_. Default:`true`.
199-
-`disable_animations` - Disables all animations in the card_(boolean)_. Default:`false`.
185+
-`hide` - Hides the[specified items](#hiding-individual-stats) from stats_(Comma-separated values)_. Default:`[] (blank array)`.
186+
-`hide_title` -_(boolean)_. Default:`false`.
187+
-`card_width` - Set the card's width manually_(number)_. Default:`500px (approx.)`.
188+
-`hide_rank` -_(boolean)_ hides the rank and automatically resizes the card width. Default:`false`.
189+
-`show_icons` -_(boolean)_. Default:`false`.
190+
-`include_all_commits` - Count total commits instead of just the current year commits_(boolean)_. Default:`false`.
191+
-`count_private` - Count private commits_(boolean)_. Default:`false`.
192+
-`line_height` - Sets the line-height between text_(number)_. Default:`25`.
193+
-`exclude_repo` - Exclude stars from specified repositories_(Comma-separated values)_. Default:`[] (blank array)`.
194+
-`custom_title` - Sets a custom title for the card. Default:`<username> Github Stats`.
195+
-`text_bold` - Use bold text_(boolean)_. Default:`true`.
196+
-`disable_animations` - Disables all animations in the card_(boolean)_. Default:`false`.
200197

201198
>Note on`hide_rank`:
202-
When hide_rank=`true`, the minimum card width is 270 px + the title length and padding.
199+
>When hide_rank=`true`, the minimum card width is 270 px + the title length and padding.
203200
204201
####Repo Card Exclusive Options:
205202

206-
-`show_owner` - Show the repo's owner name_(boolean)_
203+
-`show_owner` - Show the repo's owner name_(boolean)_
207204

208205
####Language Card Exclusive Options:
209206

210-
-`hide` - Hide the languages specified from the card_(Comma-separated values)_
211-
-`hide_title` -_(boolean)_
212-
-`layout` - Switch between two available layouts`default` &`compact`
213-
-`card_width` - Set the card's width manually_(number)_
214-
-`langs_count` - Show more languages on the card, between 1-10, defaults to 5_(number)_
215-
-`exclude_repo` - Exclude specified repositories_(Comma-separated values)_
216-
-`custom_title` - Sets a custom title for the card
207+
-`hide` - Hide the languages specified from the card_(Comma-separated values)_
208+
-`hide_title` -_(boolean)_
209+
-`layout` - Switch between two available layouts`default` &`compact`
210+
-`card_width` - Set the card's width manually_(number)_
211+
-`langs_count` - Show more languages on the card, between 1-10, defaults to 5_(number)_
212+
-`exclude_repo` - Exclude specified repositories_(Comma-separated values)_
213+
-`custom_title` - Sets a custom title for the card
217214

218215
>:warning:**Important:**
219216
>Language names should be uri-escaped, as specified in[Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding)
@@ -222,17 +219,17 @@ When hide_rank=`true`, the minimum card width is 270 px + the title length and p
222219
223220
####Wakatime Card Exclusive Options:
224221

225-
-`hide` - Hide the languages specified from the card_(Comma-separated values)_
226-
-`hide_title` -_(boolean)_
227-
-`line_height` - Sets the line-height between text_(number)_
228-
-`hide_progress` - Hides the progress bar and percentage_(boolean)_
229-
-`custom_title` - Sets a custom title for the card
230-
-`layout` - Switch between two available layouts`default` &`compact`
231-
-`langs_count` - Limit the number of languages on the card, defaults to all reported languages
232-
-`api_domain` - Set a custom API domain for the card, e.g. to use services like[Hakatime](https://github.com/mujx/hakatime) or[Wakapi](https://github.com/muety/wakapi)
233-
-`range` – Request a range different from your WakaTime default, e.g.`last_7_days`. See[WakaTime API docs](https://wakatime.com/developers#stats) for a list of available options.
222+
-`hide` - Hide the languages specified from the card_(Comma-separated values)_
223+
-`hide_title` -_(boolean)_
224+
-`line_height` - Sets the line-height between text_(number)_
225+
-`hide_progress` - Hides the progress bar and percentage_(boolean)_
226+
-`custom_title` - Sets a custom title for the card
227+
-`layout` - Switch between two available layouts`default` &`compact`
228+
-`langs_count` - Limit the number of languages on the card, defaults to all reported languages
229+
-`api_domain` - Set a custom API domain for the card, e.g. to use services like[Hakatime](https://github.com/mujx/hakatime) or[Wakapi](https://github.com/muety/wakapi)
230+
-`range` – Request a range different from your WakaTime default, e.g.`last_7_days`. See[WakaTime API docs](https://wakatime.com/developers#stats) for a list of available options.
234231

235-
---
232+
* * *
236233

237234
#GitHub Extra Pins
238235

@@ -310,7 +307,7 @@ You can use the `&layout=compact` option to change the card design.
310307

311308
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)
312309

313-
- Compact layout
310+
-Compact layout
314311

315312
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=compact)](https://github.com/anuraghazra/github-readme-stats)
316313

@@ -330,65 +327,65 @@ Change the `?username=` value to your [Wakatime](https://wakatime.com) username.
330327

331328
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod&hide_progress=true)](https://github.com/anuraghazra/github-readme-stats)
332329

333-
- Compact layout
330+
-Compact layout
334331

335332
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod&layout=compact)](https://github.com/anuraghazra/github-readme-stats)
336333

337-
---
334+
* * *
338335

339336
###All Demos
340337

341-
- Default
338+
-Default
342339

343340
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)
344341

345-
- Hiding specific stats
342+
-Hiding specific stats
346343

347344
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=contribs,issues)
348345

349-
- Showing icons
346+
-Showing icons
350347

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

353-
- Customize Border Color
350+
-Customize Border Color
354351

355352
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&border_color=2e4058)
356353

357-
- Include All Commits
354+
-Include All Commits
358355

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

361-
- Themes
358+
-Themes
362359

363360
Choose from any of the[default themes](#themes)
364361

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

367-
- Gradient
364+
-Gradient
368365

369366
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&bg_color=30,e96443,904e95&title_color=fff&text_color=fff)
370367

371-
- Customizing stats card
368+
-Customizing stats card
372369

373370
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api/?username=anuraghazra&show_icons=true&title_color=fff&icon_color=79ff97&text_color=9f9f9f&bg_color=151515)
374371

375-
- Setting card locale
372+
-Setting card locale
376373

377374
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api/?username=anuraghazra&locale=es)
378375

379-
- Customizing repo card
376+
-Customizing repo card
380377

381378
![Customized Card](https://github-readme-stats.vercel.app/api/pin?username=anuraghazra&repo=github-readme-stats&title_color=fff&icon_color=f9f9f9&text_color=9f9f9f&bg_color=151515)
382379

383-
- Top languages
380+
-Top languages
384381

385382
[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)
386383

387-
- Wakatime card
384+
-Wakatime card
388385

389386
[![willianrod's wakatime stats](https://github-readme-stats.vercel.app/api/wakatime?username=willianrod)](https://github.com/anuraghazra/github-readme-stats)
390387

391-
---
388+
* * *
392389

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

@@ -416,23 +413,23 @@ NOTE: Since [#58](https://github.com/anuraghazra/github-readme-stats/pull/58) we
416413
<details>
417414
<summary><b> Guide on setting up Vercel 🔨 </b></summary>
418415

419-
1. Go to[vercel.com](https://vercel.com/)
420-
1. Click on`Log in`
421-
![](https://files.catbox.moe/tct1wg.png)
422-
1. Sign in with GitHub by pressing`Continue with GitHub`
423-
![](https://files.catbox.moe/btd78j.jpeg)
424-
1. Sign in to GitHub and allow access to all repositories, if prompted
425-
1. Fork this repo
426-
1. After forking the repo, open the[`vercel.json`](https://github.com/anuraghazra/github-readme-stats/blob/master/vercel.json#L5) file and change the`maxDuration` field to`10`
427-
1. Go back to your[Vercel dashboard](https://vercel.com/dashboard)
428-
1. Select`Import Project`
429-
![](https://files.catbox.moe/qckos0.png)
430-
1. Select`Import Git Repository`. Select root and keep everything as is.
431-
![](https://files.catbox.moe/pqub9q.png)
432-
1. Create a personal access token (PAT)[here](https://github.com/settings/tokens/new) and enable the`repo` permissions (this allows access to see private repo stats)
433-
1. Add the PAT as an environment variable named`PAT_1` (as shown).
434-
![](https://files.catbox.moe/0ez4g7.png)
435-
1. Click deploy, and you're good to go. See your domains to use the API!
416+
1.Go to[vercel.com](https://vercel.com/)
417+
2. Click on`Log in`
418+
![](https://files.catbox.moe/tct1wg.png)
419+
3. Sign in with GitHub by pressing`Continue with GitHub`
420+
![](https://files.catbox.moe/btd78j.jpeg)
421+
4. Sign in to GitHub and allow access to all repositories, if prompted
422+
5. Fork this repo
423+
6. After forking the repo, open the[`vercel.json`](https://github.com/anuraghazra/github-readme-stats/blob/master/vercel.json#L5) file and change the`maxDuration` field to`10`
424+
7. Go back to your[Vercel dashboard](https://vercel.com/dashboard)
425+
8. Select`Import Project`
426+
![](https://files.catbox.moe/qckos0.png)
427+
9. Select`Import Git Repository`. Select root and keep everything as is.
428+
![](https://files.catbox.moe/pqub9q.png)
429+
10. Create a personal access token (PAT)[here](https://github.com/settings/tokens/new) and enable the`repo` permissions (this allows access to see private repo stats)
430+
11. Add the PAT as an environment variable named`PAT_1` (as shown).
431+
![](https://files.catbox.moe/0ez4g7.png)
432+
12. Click deploy, and you're good to go. See your domains to use the API!
436433

437434
</details>
438435

@@ -443,17 +440,16 @@ this takes time. You can use this service for free.
443440

444441
However, if you are using this project and are happy with it or just want to encourage me to continue creating stuff, there are a few ways you can do it:-
445442

446-
- Giving proper credit when you use github-readme-stats on your readme, linking back to it:D
447-
- Starring and sharing the project:rocket:
448-
-[![paypal.me/anuraghazra](https://ionicabizau.github.io/badges/paypal.svg)](https://www.paypal.me/anuraghazra) - You can make one-time donations via PayPal. I'll probably buy a~~coffee~~ tea.:tea:
443+
-Giving proper credit when you use github-readme-stats on your readme, linking back to it:D
444+
-Starring and sharing the project:rocket:
445+
-[![paypal.me/anuraghazra](https://ionicabizau.github.io/badges/paypal.svg)](https://www.paypal.me/anuraghazra) - You can make one-time donations via PayPal. I'll probably buy a~~coffee~~ tea.:tea:
449446

450447
Thanks!:heart:
451448

452-
---
449+
* * *
453450

454451
[![https://vercel.com?utm_source=github_readme_stats_team&utm_campaign=oss](./powered-by-vercel.svg)](https://vercel.com?utm_source=github_readme_stats_team&utm_campaign=oss)
455452

456-
457-
Contributions are welcome! <3
453+
Contributions are welcome!&lt;3
458454

459455
Made with:heart: and JavaScript.

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp