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

How to render <> characters? #378

Closed
monolithed opened this issue Nov 14, 2017 · 3 comments
Closed

How to render <> characters? #378

monolithed opened this issue Nov 14, 2017 · 3 comments

Comments

@monolithed
Copy link

Problem:

Messages.auth('<TYPE>', <CREDENTIALS>);
Messages.auth('', );
Messages.auth('<<TYPE>>', <<CREDENTIALS>>);
Messages.auth('<>', <>);
Messages.auth('\<TYPE\>', \<CREDENTIALS\>);
Messages.auth('\', \);

Expected:

Messages.auth('<TYPE>', <CREDENTIALS>);
@jroweboy
Copy link

@monolithed Messages.auth('&lt;TYPE&gt;', &lt;CREDENTIALS&gt;); should work.

@RomanHotsiy
Copy link
Member

@monolithed can you explain where you put this content and face these issues?
Can you share a snippet of your spec?

I tried to put the first snippet into markdown blocks (e.g. description) and they worked fine. One thing to notice you have to wrap them with backticks (```) - but it's not specific to ReDoc but to markdown in general. So the following worked just fine for me:

description: |
  `Messages.auth('<TYPE>', <CREDENTIALS>);` Some free form text

or even

description: |
  ```java
  Messages.auth('<TYPE>', <CREDENTIALS>);
  ```
  Some free form text

@RomanHotsiy
Copy link
Member

@monolithed I've just managed to reproduce it. It works wrong if using just backticks without language specified:

description: |
  ```
  Messages.auth('<TYPE>', <CREDENTIALS>);
  ```
  Some free form text

I've fixed and will release a new version soon.

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

3 participants