Repository navigation
Getting wrong output form input of any username with a trailing underscore #206
Description
Description
When inputting usernames (Twitter, Github, Linkedin or Patreon) with a trailing underscore (i.e foo_), a backward slash is inserted before the trailing underscore leading to errors loading the badge correctly and having to manually fix it.
To Reproduce
Steps to reproduce the behavior:
Input:
GitHub username (use empty value to skip) foo_
Output
GitHub username (use empty value to skip) foo\_
- Run
npx readme-md-generator - Skip to username input part
- When asked to input Github username, key in
foo_ - See error
ScreenShot
Desktop:
- OS: [MacOS Catalina]
- Version [10.15.3]
Activity
jeremiahtenbrink commentedon Jun 25, 2020
I am getting wrong username values for my username at twitter.
Pretty sure its happening because of the escapeMarkdown function that is being called in cleanSocialNetworkUsername function.
c12i commentedon Jun 26, 2020
Yes indeed @jeremiahtenbrink , the error seems to be originating from the markdownEscape library. Removing the
_replacement seems to fix the issue.jeremiahtenbrink commentedon Jun 26, 2020
Interesting. Is that an option we get with that package. I'm not entirely sure why we are escaping markdown text anyway. It's not we are having to worry about other users injecting code into our readme. We aren't parsing users text and turning it into a readme. So why we are trying to escape the text I don't understand. If anyone has more insight and its something I'm missing. Please let me know.
c12i commentedon Jun 26, 2020
Perhaps @anku255 could have a good reason for that, see his pr #183
Edo78 commentedon Oct 21, 2020
I think I understood what's happening... Let's me explain but keep in mind that English isn't my first language so bear with me.
My Twitter username is _Edo_ so it must be escaped otherwise in markdown is showed as Edo (without the underscore and in italic).
The problem arise only using HTML because the URL is still escaped for markdown even if it's not parsed as markdown.