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

Commitf0daab1

Browse files
feat: added default options to readme (anuraghazra#2051)
* feat: added default options to readme* Update readme.mdCo-authored-by: Rick Staa <rick.staa@outlook.com>* fix: added default values for stats card* style: some small readme changesCo-authored-by: Rick Staa <rick.staa@outlook.com>
1 parent3a07cb0 commitf0daab1

File tree

1 file changed

+25
-23
lines changed

1 file changed

+25
-23
lines changed

‎readme.md

Lines changed: 25 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -160,16 +160,16 @@ You can customize the appearance of your `Stats Card` or `Repo Card` however you
160160

161161
####Common Options:
162162

163-
-`title_color` - Card's title color_(hex color)_
164-
-`text_color` - Body text color_(hex color)_
165-
-`icon_color` - Icons color if available_(hex color)_
166-
-`border_color` - Card's border color_(hex color)_. (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_
168-
-`hide_border` - Hides the card's border_(boolean)_
169-
-`theme` - name of the theme, choose from[all available themes](./themes/README.md)
170-
-`cache_seconds` - set the cache header manually_(min: 7200, max: 86400)_
171-
-`locale` - set the language in the card_(e.g. cn, de, es, etc.)_
172-
-`border_radius` - Corner rounding on the card
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`.
173173

174174
>Note: The minimum of cache_seconds is currently 4 hours as a temporary fix for PATs exhaustion.
175175
@@ -185,18 +185,21 @@ You can provide multiple comma-separated values in the bg_color option to render
185185
186186
####Stats Card Exclusive Options:
187187

188-
-`hide` - Hides the[specified items](#hiding-individual-stats) from stats_(Comma-separated values)_
189-
-`hide_title` -_(boolean)_
190-
-`card_width` - Set the card's width manually_(number)_
191-
-`hide_rank` -_(boolean)_ hides the rank and automatically resizes the card width
192-
-`show_icons` -_(boolean)_
193-
-`include_all_commits` - Count total commits instead of just the current year commits_(boolean)_
194-
-`count_private` - Count private commits_(boolean)_
195-
-`line_height` - Sets the line-height between text_(number)_
196-
-`exclude_repo` - Exclude stars from specified repositories_(Comma-separated values)_
197-
-`custom_title` - Sets a custom title for the card
198-
-`text_bold` - Use bold text_(boolean)_
199-
-`disable_animations` - Disables all animations in the card_(boolean)_
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`.
200+
201+
>Note on`hide_rank`:
202+
When hide_rank=`true`, the minimum card width is 270 px + the title length and padding.
200203

201204
####Repo Card Exclusive Options:
202205

@@ -454,4 +457,3 @@ Thanks! :heart:
454457
Contributions are welcome! <3
455458

456459
Made with:heart: and JavaScript.
457-

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp