Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

<path> disappears from "Preview" rendering and also from actual rendering (at least in issues). #1138

Closed
jpluimers opened this issue Dec 10, 2017 · 5 comments

Comments

@jpluimers
Copy link

jpluimers commented Dec 10, 2017

Example tests:

The above all disappeared in the "Preview" pane and later in the actual rendering of this issue.

This is the markdown I used:

<path>

> <path>

*<path>*

**<path>**

> *<path>*

> **<path>**

As a workaround, use the backtick:

<path>

<path>

<path>

<path>

<path>

<path>

This is the backticked markdown:

`<path>`

> `<path>`

*`<path>`*

**`<path>`**

> *`<path>`*

> **`<path>`**
@jpluimers jpluimers changed the title <path> disappears from preview rendering, probably also from actual rendering <path> disappears from "Preview" rendering and also from actual rendering (at least in issues). Dec 10, 2017
@kivikakk
Copy link
Contributor

👋 Please reach out to our support team with support requests in future — this repository is just for issues for the github-markup gem, which doesn't relate to our Markdown parsing.

You'll want to escape the < and >; it's interpreted as an HTML tag and removed by our sanitizer.

\<path\>

Produces:

<path>

Thanks!

@jpluimers
Copy link
Author

@kivikakk thanks for the workaround and the support team tip: I've filed a support request for this as a new feature referring to the current issue.

@kivikakk
Copy link
Contributor

@jpluimers just as a heads up, I don't think there's any change likely to be made here. The current interpretation is per the GitHub Flavored Markdown spec, per CommonMark, and a change here would make us incompatible with CommonMark.

@jpluimers
Copy link
Author

@kivikakk oh, I feel this #facepalm moment now: Markdown allows for in-line HTML, which had totally forgotten as I write most documentation in reStructuredText.

Thanks for reminding me!

@kivikakk
Copy link
Contributor

@jpluimers aaaaaa, and I didn't realise it wasn't clear from your end that that was what was happening! We got there ❤️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants