Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

HTML tags should be escaped

See original GitHub issue

Hello, thanks for the awesome tool.

When I develop React related code I usually use <Block /> syntax in commit messages (but with no backticks). This leads to that kind of changelogs being generated:

I think such HTML constructs should be escaped.

Issue Analytics

  • State:open
  • Created 7 years ago
  • Comments:15 (8 by maintainers)

github_iconTop GitHub Comments

andreypoppcommented, Jul 14, 2016

You should really use backticks for any code, it looks much better.

Well… yes, but I don’t think it’s ok to expect people to write strict markdown in the commit messages, no? I mean markdown is ok as it’s human readable and will render accordingly to HTML (by github in this case). But inline HTML tags in markdown is something which is on the edge of markdown spec and is highly specific to markdown. This is why I think such tool as changeling generator should not allow leaking any HTML from commit messages to output.

hutsoncommented, Mar 26, 2018

Doesn’t Markdown treat HTML as a first-class feature (of most Markdown renders)?

Wouldn’t escaping HTML conflict with people relying on the HTML feature of Markdown rendering?

GitHub Markdown Guide.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Escape tags in html - Stack Overflow
For example, you can use < and > to indicate less than and greater than symbols. & is ampersand, etc. EDIT: That should...
Read more >
Guide to: Using HTML Tags/Characters in Labels
Escape characters will always begin with the ampersand symbol (&) and end with a semicolon symbol (;). The characters in between the ampersand...
Read more >
Which Characters Should Be Escaped Inside A "pre" tag?
To escape them in pre tag, we need to use & for HTML entity name or & for HTML entity number as a...
Read more >
HTML: No, you don't need to escape that -
Simple rule of thumb is that the character must be escaped if it's followed by a hash or an alphanumeric character. The actual,...
Read more >
HTML Escape Characters: Complete List of HTML Entities
Number Symbol Entity Name Code Description 9 Tab &Tab &#9 Tab 10 New Line &NewLine &#10 New Line 32 Space &nbsp &#32 Space
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Post

No results found

github_iconTop Related Hashnode Post

No results found