redoc icon indicating copy to clipboard operation
redoc copied to clipboard

Emoji Support

Open valoricDe opened this issue 1 year ago • 3 comments

Describe the problem to be solved In our static markdown files we use a lot of "emojis" in github markdown flavor to document the status of current affairs. For instance: ⚠️ :warning: | 🔴 :red_circle: | ❌ :x: | ✅ etc.

The documentation of redocly states that all standard features of github markdown are supported like emphasis, inline code... https://redocly.com/docs/developer-portal/guides/markdown/ So I thought that also emojis would, but in our document the cleartext is rendered.

Describe the solution you'd like Adapt the redocly markdown parser to support the colon syntax

Describe alternatives you've considered I thougt maybe an github markdown emoji to unicode converter would suffice, but it will be not the same.

Additional context Anything else one would need to know?

valoricDe avatar Oct 02 '23 14:10 valoricDe

What about pasting the actual emoji into the Markdown? ⚠️

For example, GitHub's editor replaces as you type with the syntax... but if you also copy/paste from another editor, it will replace it too upon rendering.

This is a :warning: for you

This isn't something we would consider a bug though. More of a feature... and I think we'll change our Markdown renderer in the next major version.

adamaltman avatar Oct 06 '23 22:10 adamaltman

Sometimes it's to easy 🙈 Thank you for changing the type to be more appropriate.

valoricDe avatar Oct 09 '23 15:10 valoricDe

Apidog is supported, you can give it a try. It is also a tool for generating documents, simple and easy to get started with.

satokenta940 avatar May 10 '24 04:05 satokenta940