Redocly / redoc

📘 OpenAPI/Swagger-generated API Reference Documentation
https://redocly.github.io/redoc/
MIT License
23.25k stars 2.28k forks source link

Emoji Support #2424

Open valoricDe opened 11 months ago

valoricDe commented 11 months ago

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?

adamaltman commented 11 months ago

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.

valoricDe commented 11 months ago

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

satokenta940 commented 3 months ago

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