Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP


Content is not properly escaped #61

ErisDS opened this Issue · 0 comments

1 participant


Things that look like HTML tags disappear from the output because they get rendered as part of the DOM.

For a reasonably sane example:

 * ## My Function
 * Description
 * @return {Promise<String>}

The <String> part disappears whereas I would expect it to be output as text.

This is the same regardless of whether it is in a title, description, tag name, tag type, tag description etc.
Not sure if it should be escaped for anything other than the tag type, but this sort of formatting is reasonably common I think.

@ErisDS ErisDS referenced this issue in TryGhost/Ghost

Proposal: Use JSDoc Code Documentation #2622

@ErisDS ErisDS referenced this issue from a commit in ErisDS/docker
@ErisDS ErisDS Escape HTML chars in types 24fb800
@jbt jbt closed this in #64
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.