Skip to content

Commit 447796d

Browse files
authored
docs: add description for new options photo_quality and photo_resize (#475)
1 parent ce588e4 commit 447796d

File tree

1 file changed

+46
-34
lines changed

1 file changed

+46
-34
lines changed

README.md

Lines changed: 46 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -83,104 +83,116 @@ You can customize the appearance of all your cards however you wish with URL par
8383
<tr>
8484
<td><p align="left"><code>title_color</code></p></td>
8585
<td><p align="left">Card's title color.</p></td>
86-
<td><p align="left">string (hex color)</p></td>
87-
<td><p align="left"><code>2f80ed</code></p></td>
86+
<td><p align="center"><code>string</code></br>(hex color)</p></td>
87+
<td><p align="center"><code>2f80ed</code></p></td>
8888
</tr>
8989
<tr>
9090
<td><p align="left"><code>text_color</code></p></td>
9191
<td><p align="left">Body text color.</p></td>
92-
<td><p align="left">string (hex color)</p></td>
93-
<td><p align="left"><code>434d58</code></p></td>
92+
<td><p align="center"><code>string</code></br>(hex color)</p></td>
93+
<td><p align="center"><code>434d58</code></p></td>
9494
</tr>
9595
<tr>
9696
<td><p align="left"><code>icon_color</code></p></td>
9797
<td><p align="left">Icons color.</p></td>
98-
<td><p align="left">string (hex color)</p></td>
99-
<td><p align="left"><code>4c71f2</code></p></td>
98+
<td><p align="center"><code>string</code></br>(hex color)</p></td>
99+
<td><p align="center"><code>4c71f2</code></p></td>
100100
</tr>
101101
<tr>
102102
<td><p align="left"><code>border_color</code></p></td>
103103
<td><p align="left">Card's border color. Does not apply when <code>hide_border</code> is enabled.</p></td>
104-
<td><p align="left">string (hex color)</p></td>
105-
<td><p align="left"><code>e4e2e2</code></p></td>
104+
<td><p align="center"><code>string</code></br>(hex color)</p></td>
105+
<td><p align="center"><code>e4e2e2</code></p></td>
106106
</tr>
107107
<tr>
108108
<td><p align="left"><code>bg_color</code></p></td>
109109
<td><p align="left">Card's background color.</p></td>
110-
<td><p align="left">string (hex color or a gradient in the form of <i>angle,start,end</i>)</p></td>
111-
<td><p align="left"><code>fffefe</code></p></td>
110+
<td><p align="center"><code>string</code></br>(hex color or a gradient in the form of <i>angle,start,end</i>)</p></td>
111+
<td><p align="center"><code>fffefe</code></p></td>
112112
</tr>
113113
<tr>
114114
<td><p align="left"><code>stroke_color</code></p></td>
115115
<td><p align="left">Profile image border color. Does not apply when <code>hide_stroke</code> is enabled.</p></td>
116-
<td><p align="left">string (hex color)</p></td>
117-
<td><p align="left"><code>e4e2e2</code> or <code>border_color</code> query</p></td>
116+
<td><p align="center"><code>string</code></br>(hex color)</p></td>
117+
<td><p align="center"><code>e4e2e2</code> or <code>border_color</code> query</p></td>
118118
</tr>
119119
<tr>
120120
<td><p align="left"><code>username_color</code></p></td>
121121
<td><p align="left">Username text color.</p></td>
122-
<td><p align="left">string (hex color)</p></td>
123-
<td><p align="left"><code>434d58</code> or <code>text_color</code> query</p></td>
122+
<td><p align="center"><code>string</code></br>(hex color)</p></td>
123+
<td><p align="center"><code>434d58</code> or <code>text_color</code> query</p></td>
124124
</tr>
125125
<tr>
126126
<td><p align="left"><code>theme</code></p></td>
127127
<td><p align="left">Name of the theme, choose from <a href="/themes">all available themes</a>.</p></td>
128-
<td><p align="left">enum</p></td>
129-
<td><p align="left"><code>default</code></p></td>
128+
<td><p align="center"><code>enum</code></p></td>
129+
<td><p align="center"><code>default</code></p></td>
130130
</tr>
131131
<tr>
132132
<td><p align="left"><code>locale</code></p></td>
133133
<td><p align="left">Sets the language in the card, you can check full list of available locales <a href="/docs/translations.md">here</a>.</p></td>
134-
<td><p align="left">enum</p></td>
135-
<td><p align="left"><code>en</code></p></td>
134+
<td><p align="center"><code>enum</code></p></td>
135+
<td><p align="center"><code>en</code></p></td>
136136
</tr>
137137
<tr>
138138
<td><p align="left"><code>border_width</code></p></td>
139139
<td><p align="left">Sets the border's width manually.</p></td>
140-
<td><p align="left">number</p></td>
141-
<td><p align="left"><code>1</code></p></td>
140+
<td><p align="center"><code>number</code></p></td>
141+
<td><p align="center"><code>1</code></p></td>
142142
</tr>
143143
<tr>
144144
<td><p align="left"><code>border_radius</code></p></td>
145145
<td><p align="left">Corner rounding on the card.</p></td>
146-
<td><p align="left">number</td>
147-
<td><p align="left"><code>4.5</code></p></td>
146+
<td><p align="center"><code>number</code></td>
147+
<td><p align="center"><code>4.5</code></p></td>
148148
</tr>
149149
<tr>
150150
<td><p align="left"><code>hide</code></p></td>
151151
<td><p align="left">Hides the <a href="#hiding-individual-stats">specified items</a> from stats.</p></td>
152-
<td><p align="left">string (comma-separated values)</td>
153-
<td><p align="left"><code>null</code></p></td>
152+
<td><p align="center"><code>string</code></br>(comma-separated values)</td>
153+
<td><p align="center"><code>null</code></p></td>
154154
</tr>
155155
<tr>
156156
<td><p align="left"><code>show</code></p></td>
157157
<td><p align="left">Shows <a href="#showing-additional-individual-stats">additional items</a> on stats card.</p></td>
158-
<td><p align="left">string (comma-separated values)</td>
159-
<td><p align="left"><code>null</code></p></td>
158+
<td><p align="center"><code>string</code></br>(comma-separated values)</td>
159+
<td><p align="center"><code>null</code></p></td>
160160
</tr>
161161
<tr>
162162
<td><p align="left"><code>format</code></p></td>
163163
<td><p align="left">Output format card option (i.e. <code>svg</code>, <code>png</code>, or <code>json</code>).</p></td>
164-
<td><p align="left">enum</td>
165-
<td><p align="left"><code>svg</code></p></td>
164+
<td><p align="center"><code>enum</code></td>
165+
<td><p align="center"><code>svg</code></p></td>
166166
</tr>
167167
<tr>
168168
<td><p align="left"><code>disabled_animations</code></p></td>
169169
<td><p align="left">Disables all animations in the card.</p></td>
170-
<td><p align="left">boolean</td>
171-
<td><p align="left"><code>false</code></p></td>
170+
<td><p align="center"><code>boolean</code></td>
171+
<td><p align="center"><code>false</code></p></td>
172172
</tr>
173173
<tr>
174174
<td><p align="left"><code>hide_border</code></p></td>
175175
<td><p align="left">Hides the card's border.</p></td>
176-
<td><p align="left">boolean</td>
177-
<td><p align="left"><code>false</code></p></td>
176+
<td><p align="center"><code>boolean</code></td>
177+
<td><p align="center"><code>false</code></p></td>
178178
</tr>
179179
<tr>
180180
<td><p align="left"><code>hide_stroke</code></p></td>
181181
<td><p align="left">Hides the image's profile stroke in the card.</p></td>
182-
<td><p align="left">boolean</td>
183-
<td><p align="left"><code>false</code></p></td>
182+
<td><p align="center"><code>boolean</code></td>
183+
<td><p align="center"><code>false</code></p></td>
184+
</tr>
185+
<tr>
186+
<td><p align="left"><code>photo_quality</code></p></td>
187+
<td><p align="left">Quality of the profile image, represented as a percentage (1-100).</p></td>
188+
<td><p align="center"><code>number</code></br>(percentage)</p></td>
189+
<td><p align="center"><code>15</code></p></td>
190+
</tr>
191+
<tr>
192+
<td><p align="left"><code>photo_resize</code></p></td>
193+
<td><p align="left">Resize the profile image to a specific width, in pixels. Minimum allowed value is 10px.</p></td>
194+
<td><p align="center"><code>number</code></br>(pixels)</p></td>
195+
<td><p align="center"><code>150</code></p></td>
184196
</tr>
185197
</table>
186198

0 commit comments

Comments
 (0)