Angled brackets not rendering in markdown

[TimShererAtAquent]

Angled brackets are used in plaintext to indicate placeholder text, as follows: (Example from Get-Help.md)

“To see a particular topic, type: Get-Help about_, such as Get-Help about_Comparison_Operators.”

The result lacks the content in the brackets:

“To see a particular topic, type: Get-Help about, such as Get-Help about_Comparison_Operators.”

(There is a separate issue about the underscore after the word “about”. I haven’t found that in other topics, yet, so I can’t describe exactly when it happens.)

The markdown is probably reading as an XML tag.

Possible solution:

Replace angled brackets in text with < and >. (ampersand-l-t or g-t)

No change for angled brackets in code blocks – these work and shouldn’t be tinkered with.

I don’t know whether this will work and render correctly in the XML, but it works in atom preview mode.

[vors]

We are trying to follow CommonMark spec, and it allows us to do escaping with \< instead of &lt.

Atom / VSCode has an issue with their markdown preview. One of the industry-wide challenges is markdown variations. We supporting CommonMark, because it has a really good spec and set of tests for implementations. Also it's mostly compatible with GitHub Flavored markdown.

When you call New-Markdown in PlatyPS, we inject escaping for < and > in the form on \< and \>. Same goes about [ ] ( ) and back-ticks.

[TimShererAtAquent]

Per JP's suggestion, I looked at the topic in GitHub. The brackets escape correctly, as expected from the spec. Let's mark this issue closed.