From 027655f023f3abad48cafe6b2eb98262550c3201 Mon Sep 17 00:00:00 2001 From: ngtrhieu Date: Wed, 29 Jul 2020 14:43:37 +0800 Subject: [PATCH] docs: add special note for uri-encoded names add a reminding section for folks who trying to hide c++ or languages with uri-reserved charaters. --- readme.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/readme.md b/readme.md index 3c1feed450f97..8b5788aff655d 100644 --- a/readme.md +++ b/readme.md @@ -181,6 +181,10 @@ You can use `?hide=language1,language2` parameter to hide individual languages. [![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&hide=javascript,html)](https://github.com/anuraghazra/github-readme-stats) ``` +> :warning: **Important:** +> Language names 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`, etc.) + ### Compact Language Card Layout You can use the `&layout=compact` option to change the card design.