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

Ampersand character within triple backquotes is incorrectly rendered #2225

Closed
dalbani opened this issue Jun 17, 2016 · 6 comments
Closed

Ampersand character within triple backquotes is incorrectly rendered #2225

dalbani opened this issue Jun 17, 2016 · 6 comments

Comments

@dalbani
Copy link
Contributor

dalbani commented Jun 17, 2016

It seems that all & characters contained within triple backquotes are incorrectly rendered, as & instead of simply &.
For example, for this definition:

swagger: '2.0'
info:
  title: Test API
  description: |
    A description with an ampersand with triple backquotes:
    ```&```
...

The result is:
backquotes

Version: latest master as of today, i.e. commit efb77652274e99893b11848f02d9dc37d07344aa.

I supposed the issue is not directly related to SwaggerUI itself, but I have no idea which dependency library is responsible for the rendering.

@bholt
Copy link

bholt commented Nov 3, 2016

Running into this myself. I think it may be a bug in the marked.js library:

Although I see that swagger-ui has injested that dependency:

@asnelzin
Copy link

Actually, it reproduces not only with ampersand, but with some other special characters. Is there any progress?

@jobec
Copy link

jobec commented Jan 30, 2017

Same here.
Make putting code examples in the description rather useless...

The Swagger Editor doesn't have this problem btw.

@webron
Copy link
Contributor

webron commented Mar 24, 2017

Please retest with 3.X.

@webron webron closed this as completed Mar 24, 2017
@dalbani
Copy link
Contributor Author

dalbani commented Jul 20, 2017

@webron: still applicable on 3.0.18.
Can be tested with something as simple as ```&``` `&`.
It's rendered in both cases as &.
On the other hand, <code>&</code> works fine.

@webron
Copy link
Contributor

webron commented Jul 20, 2017

The & is known and is tackled in a different ticket, I just can't find it now.

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

5 participants