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

Studio fails to render CommonMarkings #906

Closed
eelcofolkertsma opened this issue Dec 19, 2023 · 4 comments · Fixed by #912
Closed

Studio fails to render CommonMarkings #906

eelcofolkertsma opened this issue Dec 19, 2023 · 4 comments · Fixed by #912
Labels
bug Something isn't working

Comments

@eelcofolkertsma
Copy link
Contributor

eelcofolkertsma commented Dec 19, 2023

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:

* Turn a specific streetlight on/off 🌃  
* Dim a specific streetlight 😎
* Receive real-time information about environmental lighting conditions 📈

To the right side bullets and bold are missing

  • Screenshots

image

  • Link to GitHub repository with project that has issues

Expected behavior

Rendered text following CommonMark instructions

@eelcofolkertsma eelcofolkertsma added the bug Something isn't working label Dec 19, 2023
Copy link

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.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

@eelcofolkertsma
Copy link
Contributor Author

eelcofolkertsma commented Dec 23, 2023

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

  description: >
    The Smartylighting Streetlights API allows you to remotely manage the city
    lights.
    ### Check out its awesome features:

    * Turn a specific streetlight on/off 🌃  
    * Dim a specific streetlight 😎
    * Receive real-time information about environmental lighting conditions 📈

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??

  description: "The Smartylighting Streetlights API allows you to remotely manage the city lights.\n\n### Check out its awesome features:\n\n* Turn a specific streetlight on/off \U0001F303\n* Dim a specific streetlight \U0001F60E\n* Receive real-time information about environmental lighting conditions \U0001F4C8\n"

@eelcofolkertsma
Copy link
Contributor Author

Solution can be found at editor.swagger pet store example

replace "description: >" with "description:|-" and the engine renders as expected

@KhudaDad414
Copy link
Member

@eelcofolkertsma I see the issue here. can you open a PR with a fix?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants