Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

docs using xml in code blocks will improperly render #11438

Open
aaronmarkham opened this issue Jun 27, 2018 · 5 comments · Fixed by #12482
Open

docs using xml in code blocks will improperly render #11438

aaronmarkham opened this issue Jun 27, 2018 · 5 comments · Fixed by #12482
Labels

Comments

@aaronmarkham
Copy link
Contributor

As this has bitten me several times now, so I'm writing this up as an issue. It is likely a bug in recommonmark.

If you use entities that can be interpreted as tags, like

#Three opening backticks
'''
<dependency>
...

This will render improperly.

If you use

```xml
<dependency>
...

This will render improperly.

If you use

```html
<dependency>
...

This will render properly.

There may be other workarounds, but for now I'm using ```html
This has been coming up in documentation for scala.

@frankfliu
Copy link
Contributor

Hi @aaronmarkham thanks for submitting the issue, @sandeep-krishnamurthy requesting this be labeled Doc

@ThomasDelteil
Copy link
Contributor

@aaronmarkham is there further action required on this issue?

@aaronmarkham
Copy link
Contributor Author

Actually there is. Something keeps mucking with the code and escaping it improperly.

@aaronmarkham
Copy link
Contributor Author

@andrewfayres and @lanking520 - They said they might be able to help figure out what is going on with it.

@lanking520
Copy link
Member

Basically it's a transition failure, such as the example below:
https://github.com/apache/incubator-mxnet/blob/master/docs/tutorials/scala/mxnet_scala_on_intellij.md

and

http://mxnet.incubator.apache.org/tutorials/scala/mxnet_scala_on_intellij.html

If you compare the dependencies in the markdown is showing correctly, however, in website is wrongly translated.

<dependency> Sample </dependency>
<dependency>Sample dependency>

</ seemed to have some issues.

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

Successfully merging a pull request may close this issue.

5 participants