markdown-template icon indicating copy to clipboard operation
markdown-template copied to clipboard

Cannot create tables with text under "summary" and "description" tags.

Open dinuka-kasun-medis opened this issue 2 years ago • 2 comments

Describe the bug

Like in swagger I cannot create tables under the "summary" and "description" tags.

How to Reproduce

Tried to add a table as follows:

summary: | Test summary description. +------------+ | H1 | H2 | +-----+------+ | ccc | ccc | +-----+------+ | ccc | ccc | +-----+------+

But It shows as a paragraph without new lines. It may be the "trim" used in text under "summary" tag.

https://github.com/asyncapi/markdown-template/blob/master/components/Operations.js#L119

Also, in my case | and > works as same for multiple lines with "summary" and "description" tags.

Ex: "description: | " And "description: > "

Expected behavior

Want a nice table after generate the file like swagger. I think enabling newline it will automatically fixed.

dinuka-kasun-medis avatar Jan 11 '24 09:01 dinuka-kasun-medis

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.

github-actions[bot] avatar Jan 11 '24 09:01 github-actions[bot]

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

github-actions[bot] avatar May 11 '24 00:05 github-actions[bot]