-
-
Notifications
You must be signed in to change notification settings - Fork 99
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
Studio fails to render CommonMarkings #906
Comments
Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request. |
The issue has been addressed by altering templates in studio, but that is not a real solution! Original description for streetlights-Kafka template reads quite OK as code (studio left hand) but fails to render in html (studio right hand). This triggered the issue
Revised description in current streetlights-Kafka template reads horrible as code (lefthand) but has nice rendering. So do we want to set an example of horrible coding??
|
Solution can be found at editor.swagger pet store example replace "description: >" with "description:|-" and the engine renders as expected |
@eelcofolkertsma I see the issue here. can you open a PR with a fix? |
Describe the bug
CommonMark in demo document does not render in righthand "human friendly" rendering of document.
How to Reproduce
Open studio at https://studio.asyncapi.com/#introduction
Look for /info/description element in title: Streetlights Kafka API (the demo document)
You find Common Mark in lines 8-12:
Check out its awesome features:
To the right side bullets and bold are missing
Expected behavior
Rendered text following CommonMark instructions
The text was updated successfully, but these errors were encountered: