Allow HTML Comments in Markdown (BB-9958)

Kevin Cox avatarKevin Cox created an issue

Currently if a HTML comment is encountered in a markdown file it is escaped and displayed literally. Most[citation needed] implementations treat the comment as HTML and pass it through.

<!-- This gets escaped and displayed,
      but it would be nice if it was a HTML comment. -->

Additionally, some implementations completely remove comments with three leading dashes.

<!--- It would be nice if this was removed completely. -->

Comments (4)

  1. Kevin Cox

    The use case is basically notes for people writing the document, but that shouldn't be included in the final product. For example latex has % and RST has ... Markdown users usually use HTML comments.

  2. Log in to comment
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.