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

Commitc6c4a88

Browse files
authored
docs: improve query options appereance using tables (anuraghazra#3484)
1 parent1262002 commitc6c4a88

File tree

1 file changed

+61
-49
lines changed

1 file changed

+61
-49
lines changed

‎readme.md

Lines changed: 61 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -288,16 +288,18 @@ You can customize the appearance of all your cards however you wish with URL par
288288

289289
####Common Options
290290

291-
*`title_color` - Card's title color*(hex color)*. Default:`2f80ed`.
292-
*`text_color` - Body text color*(hex color)*. Default:`434d58`.
293-
*`icon_color` - Icons color if available*(hex color)*. Default:`4c71f2`.
294-
*`border_color` - Card's border color*(hex color)*. Default:`e4e2e2` (does not apply when`hide_border` is enabled).
295-
*`bg_color` - Card's background color*(hex color)***or** a gradient in the form of*angle,start,end*. Default:`fffefe`
296-
*`hide_border` - Hides the card's border*(boolean)*. Default:`false`
297-
*`theme` - Name of the theme; choose from[all available themes](themes/README.md). Default:`default` theme.
298-
*`cache_seconds` - Sets the cache header manually*(min: 21600, max: 86400)*. Default:`21600 seconds (6 hours)`.
299-
*`locale` - Sets the language in the card, you can check full list of available locales[here](#available-locales). Default:`en`.
300-
*`border_radius` - Corner rounding on the card. Default:`4.5`.
291+
| Name| Description| Type| Default value|
292+
| ---| ---| ---| ---|
293+
|`title_color`| Card's title color.| string (hex color)|`2f80ed`|
294+
|`text_color`| Body text color.| string (hex color)|`434d58`|
295+
|`icon_color`| Icons color if available.| string (hex color)|`4c71f2`|
296+
|`border_color`| Card's border color. Does not apply when`hide_border` is enabled.| string (hex color)|`e4e2e2`|
297+
|`bg_color`| Card's background color.| string (hex color or a gradient in the form of*angle,start,end*)|`fffefe`|
298+
|`hide_border`| Hides the card's border.| boolean|`false`|
299+
|`theme`| Name of the theme, choose from[all available themes](themes/README.md).| enum|`default`|
300+
|`cache_seconds`| Sets the cache header manually (min: 21600, max: 86400).| integer|`1800`|
301+
|`locale`| Sets the language in the card, you can check full list of available locales[here](#available-locales).| enum|`en`|
302+
|`border_radius`| Corner rounding on the card.| number|`4.5`|
301303

302304
>[!WARNING]\
303305
>We use caching to decrease the load on our servers (see<https://github.com/anuraghazra/github-readme-stats/issues/1471#issuecomment-1271551425>). Our cards have a default cache of 6 hours (21600 seconds). Also, note that the cache is clamped to a minimum of 6 hours and a maximum of 24 hours. If you want the data on your statistics card to be updated more often you can[deploy your own instance](#deploy-on-your-own) and set[environment variable](#disable-rate-limit-protections)`CACHE_SECONDS` to a value of your choosing.
@@ -364,47 +366,55 @@ If we don't support your language, please consider contributing! You can find mo
364366

365367
####Stats Card Exclusive Options
366368

367-
*`hide` - Hides the[specified items](#hiding-individual-stats) from stats*(comma-separated values)*. Default:`[] (blank array)`.
368-
*`hide_title` -*(boolean)*. Default:`false`.
369-
*`card_width` - Sets the card's width manually*(number)*. Default:`500px (approx.)`.
370-
*`hide_rank` -*(boolean)* hides the rank and automatically resizes the card width. Default:`false`.
371-
*`rank_icon` - Shows alternative rank icon (i.e.`github`,`percentile` or`default`). Default:`default`.
372-
*`show_icons` -*(boolean)*. Default:`false`.
373-
*`include_all_commits` - Counts total commits instead of just the current year commits*(boolean)*. Default:`false`.
374-
*`line_height` - Sets the line height between text*(number)*. Default:`25`.
375-
*`exclude_repo` - Excludes stars from specified repositories*(Comma-separated values)*. Default:`[] (blank array)`.
376-
*`custom_title` - Sets a custom title for the card. Default:`<username> GitHub Stats`.
377-
*`text_bold` - Uses bold text*(boolean)*. Default:`true`.
378-
*`disable_animations` - Disables all animations in the card*(boolean)*. Default:`false`.
379-
*`ring_color` - Color of the rank circle*(hex color)*. Defaults to the theme ring color if it exists and otherwise the title color.
380-
*`number_format` - Switches between two available formats for displaying the card values`short` (i.e.`6.6k`) and`long` (i.e.`6626`). Default:`short`.
381-
*`show` - Shows[additional items](#showing-additional-individual-stats) on stats card (i.e.`reviews`,`discussions_started`,`discussions_answered`,`prs_merged` or`prs_merged_percentage`)*(Comma-separated values)*. Default:`[] (blank array)`.
369+
| Name| Description| Type| Default value|
370+
| ---| ---| ---| ---|
371+
|`hide`| Hides the[specified items](#hiding-individual-stats) from stats.| string (comma-separated values)|`null`|
372+
|`hide_title`| Hides the title of your stats card.| boolean|`false`|
373+
|`card_width`| Sets the card's width manually.| number|`500px (approx.)`|
374+
|`hide_rank`| Hides the rank and automatically resizes the card width.| boolean|`false`|
375+
|`rank_icon`| Shows alternative rank icon (i.e.`github`,`percentile` or`default`).| enum|`default`|
376+
|`show_icons`| Shows icons near all stats.| boolean|`false`|
377+
|`include_all_commits`| Count total commits instead of just the current year commits.| boolean|`false`|
378+
|`line_height`| Sets the line height between text.| integer|`25`|
379+
|`exclude_repo`| Excludes specified repositories.| string (comma-separated values)|`null`|
380+
|`custom_title`| Sets a custom title for the card.| string|`<username> GitHub Stats`|
381+
|`text_bold`| Uses bold text.| boolean|`true`|
382+
|`disable_animations`| Disables all animations in the card.| boolean|`false`|
383+
|`ring_color`| Color of the rank circle.| string (hex color)|`2f80ed`|
384+
|`number_format`| Switches between two available formats for displaying the card values`short` (i.e.`6.6k`) and`long` (i.e.`6626`).| enum|`short`|
385+
|`show`| Shows[additional items](#showing-additional-individual-stats) on stats card (i.e.`reviews`,`discussions_started`,`discussions_answered`,`prs_merged` or`prs_merged_percentage`).| string (comma-separated values)|`null`|
382386

383387
>[!NOTE]\
384388
>When hide\_rank=`true`, the minimum card width is 270 px + the title length and padding.
385389
386390
####Repo Card Exclusive Options
387391

388-
*`show_owner` - Shows the repo's owner name*(boolean)*. Default:`false`.
389-
*`description_lines_count` - Manually set the number of lines for the description*(number)*. Specified value will be clamped between 1 and 3. If this parameter is not specified, the number of lines will be automatically adjusted according to the actual length of the description. Default:`undefined`.
392+
| Name| Description| Type| Default value|
393+
| ---| ---| ---| ---|
394+
|`show_owner`| Shows the repo's owner name.| boolean|`false`|
395+
|`description_lines_count`| Manually set the number of lines for the description. Specified value will be clamped between 1 and 3. If this parameter is not specified, the number of lines will be automatically adjusted according to the actual length of the description.| number|`null`|
390396

391397
####Gist Card Exclusive Options
392398

393-
*`show_owner` - Shows the gist's owner name*(boolean)*. Default:`false`.
399+
| Name| Description| Type| Default value|
400+
| ---| ---| ---| ---|
401+
|`show_owner`| Shows the gist's owner name.| boolean|`false`|
394402

395403
####Language Card Exclusive Options
396404

397-
*`hide` - Hides the languages specified from the card*(Comma-separated values)*. Default:`[] (blank array)`.
398-
*`hide_title` -*(boolean)*. Default:`false`.
399-
*`layout` - Switches between five available layouts`normal` &`compact` &`donut` &`donut-vertical` &`pie`. Default:`normal`.
400-
*`card_width` - Sets the card's width manually*(number)*. Default`300`.
401-
*`langs_count` - Shows more languages on the card, between 1-20*(number)*. Default:`5` for`normal` and`donut`,`6` for other layouts.
402-
*`exclude_repo` - Excludes specified repositories*(Comma-separated values)*. Default:`[] (blank array)`.
403-
*`custom_title` - Sets a custom title for the card*(string)*. Default`Most Used Languages`.
404-
*`disable_animations` - Disables all animations in the card*(boolean)*. Default:`false`.
405-
*`hide_progress` - Uses the compact layout option, hides percentages, and removes the bars. Default:`false`.
406-
*`size_weight` - Configures language stats algorithm*(number)* (see[Language stats algorithm](#Language-stats-algorithm)), defaults to 1.
407-
*`count_weight` - Configures language stats algorithm*(number)* (see[Language stats algorithm](#Language-stats-algorithm)), defaults to 0.
405+
| Name| Description| Type| Default value|
406+
| ---| ---| ---| ---|
407+
|`hide`| Hides the[specified languages](#hide-individual-languages) from card.| string (comma-separated values)|`null`|
408+
|`hide_title`| Hides the title of your card.| boolean|`false`|
409+
|`layout`| Switches between five available layouts`normal` &`compact` &`donut` &`donut-vertical` &`pie`.| enum|`normal`|
410+
|`card_width`| Sets the card's width manually.| number|`300`|
411+
|`langs_count`| Shows more languages on the card, between 1-20.| integer|`5` for`normal` and`donut`,`6` for other layouts|
412+
|`exclude_repo`| Excludes specified repositories.| string (comma-separated values)|`null`|
413+
|`custom_title`| Sets a custom title for the card.| string|`Most Used Languages`|
414+
|`disable_animations`| Disables all animations in the card.| boolean|`false`|
415+
|`hide_progress`| Uses the compact layout option, hides percentages, and removes the bars.| boolean|`false`|
416+
|`size_weight`| Configures language stats algorithm (see[Language stats algorithm](#language-stats-algorithm)).| integer|`1`|
417+
|`count_weight`| Configures language stats algorithm (see[Language stats algorithm](#language-stats-algorithm)).| integer|`0`|
408418

409419
>[!WARNING]\
410420
>Language names should be URI-escaped, as specified in[Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding)
@@ -413,16 +423,18 @@ If we don't support your language, please consider contributing! You can find mo
413423
414424
####WakaTime Card Exclusive Options
415425

416-
*`hide` - Hides the languages specified from the card*(Comma-separated values)*. Default:`[] (blank array)`.
417-
*`hide_title` -*(boolean)*. Default`false`.
418-
*`line_height` - Sets the line height between text*(number)*. Default`25`.
419-
*`hide_progress` - Hides the progress bar and percentage*(boolean)*. Default`false`.
420-
*`custom_title` - Sets a custom title for the card*(string)*. Default`WakaTime Stats`.
421-
*`layout` - Switches between two available layouts`default` &`compact`. Default`default`.
422-
*`langs_count` - Limits the number of languages on the card, defaults to all reported languages*(number)*.
423-
*`api_domain` - Sets 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)*(string)*. Default`Waka API`.
424-
*`display_format` - Sets the WakaTime stats display format. Choose`time` to display time-based stats or`percent` to show percentages. Default:`time`.
425-
*`disable_animations` - Disables all animations in the card*(boolean)*. Default:`false`.
426+
| Name| Description| Type| Default value|
427+
| ---| ---| ---| ---|
428+
|`hide`| Hides the languages specified from the card.| string (comma-separated values)|`null`|
429+
|`hide_title`| Hides the title of your card.| boolean|`false`|
430+
|`line_height`| Sets the line height between text.| integer|`25`|
431+
|`hide_progress`| Hides the progress bar and percentage.| boolean|`false`|
432+
|`custom_title`| Sets a custom title for the card.| string|`WakaTime Stats`|
433+
|`layout`| Switches between two available layouts`default` &`compact`.| enum|`default`|
434+
|`langs_count`| Limits the number of languages on the card, defaults to all reported languages.| integer|`null`|
435+
|`api_domain`| Sets 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)| string|`Waka API`|
436+
|`display_format`| Sets the WakaTime stats display format. Choose`time` to display time-based stats or`percent` to show percentages.| enum|`time`|
437+
|`disable_animations`| Disables all animations in the card.| boolean|`false`|
426438

427439
***
428440

0 commit comments

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