Skip to content

Commit abda6d3

Browse files
docs(readme): add warning that custom title value should be URL encoded (anuraghazra#4547)
Co-authored-by: Alexandr <qwerty541zxc@gmail.com>
1 parent 756a601 commit abda6d3

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

readme.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -388,6 +388,9 @@ If we don't support your language, please consider contributing! You can find mo
388388
| `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` |
389389
| `commits_year` | Filters and counts only commits made in the specified year. | integer _(YYYY)_ | `<current year> (one year to date)` |
390390

391+
> [!WARNING]\
392+
> Custom title should be URI-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding) (i.e: `Anurag's GitHub Stats` should become `Anurag%27s%20GitHub%20Stats`). You can use [urlencoder.org](https://www.urlencoder.org/) to help you do this automatically.
393+
391394
> [!NOTE]\
392395
> When hide\_rank=`true`, the minimum card width is 270 px + the title length and padding.
393396
@@ -502,9 +505,7 @@ You can customize the appearance and behavior of the top languages card using th
502505
| `stats_format` | Switches between two available formats for language's stats `percentages` and `bytes`. | enum | `percentages` |
503506

504507
> [!WARNING]\
505-
> Language names should be URI-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding)
506-
> (i.e: `c++` should become `c%2B%2B`, `jupyter notebook` should become `jupyter%20notebook`, etc.) You can use
507-
> [urlencoder.org](https://www.urlencoder.org/) to help you do this automatically.
508+
> Language names and custom title should be URI-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding) (i.e: `c++` should become `c%2B%2B`, `jupyter notebook` should become `jupyter%20notebook`, `Most Used Languages` should become `Most%20Used%20Languages`, etc.) You can use [urlencoder.org](https://www.urlencoder.org/) to help you do this automatically.
508509
509510
### Language stats algorithm
510511

@@ -658,6 +659,9 @@ You can customize the appearance and behavior of the WakaTime stats card using t
658659
| `display_format` | Sets the WakaTime stats display format. Choose `time` to display time-based stats or `percent` to show percentages. | enum | `time` |
659660
| `disable_animations` | Disables all animations in the card. | boolean | `false` |
660661

662+
> [!WARNING]\
663+
> Custom title should be URI-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding) (i.e: `WakaTime Stats` should become `WakaTime%20Stats`). You can use [urlencoder.org](https://www.urlencoder.org/) to help you do this automatically.
664+
661665
### Demo
662666

663667
![Harlok's WakaTime stats](https://github-readme-stats.vercel.app/api/wakatime?username=ffflabs)

0 commit comments

Comments
 (0)