Can’t get proper paragraphs in Markdown in descriptions

[michalrus]

Q	A
Bug or feature request?	Bug
Which Swagger/OpenAPI version?	2.0
Which Swagger-UI version?	3.4.1
How did you install Swagger-UI?	From the dist/ directory in the repo.
Which browser & version?	Chromium 62.0.3202.75
Which operating system?	NixOS 17.09

Demonstration API definition

choose-one: "irrelevant, applies to all / we’re using JSON autogenerated from Haskell / NDA / I don’t know the format to create a minimal repro by hand"

Configuration (browser query string, constructor, config.yaml)

"irrelevant as well, applies to all"

Expected Behavior

Each time there is "Par 1\n\nPar 2" in a "description" field, we should get proper paragraphs. Paragraph spacing should be greater than 0.

Current Behavior

There’s no space between "Par 1" and "Par 2", they look as if the "description" contained just "Par 1\nPar 2". The <p/>s are indeed generated correctly, but their margin is 0.

Possible Solution

Fix <p/>’s CSS.

Also: we’re now using "\n\n\xe005e\n\n" instead of just \n\n as a workaround to add artificial spacing between paragraphs. But this is crazy.

Context

Describing more complex stuff often requires more than one paragraph. And if they are not spaced with some kind of vertical whitespace (<p/> margin), it’s very unreadable.

[Peter-Simpson]

Hi,

I'm running the latest released Swagger-UI version and have the lines below in my yaml file. However, Swagger UI doesn't generate multiple paragraphs as expected. Instead, each paragraph starts on a new line without a gap between it and the preceding line.

Is it the same bug as reported here?

Thanks, Peter

Appearance in Swagger UI:

YAML File:

[michalrus]

Yes, yes, indeed it is. Sad. 💔

[yufei-cai]

This line looks like the cause. Removing it fixed paragraph formatting for me (whatever other effects there may be).

[westonpace]

A horizontal rule can be used as a workaround. Ironically the horizontal rule itself does not display correctly but it does actually create a paragraph. At least in version 3.23.3.

`    put:
      summary: Some summary
      description:
        This description

        ---

        Will have

        ---

        Multiple paragraphs

[webron]

Everyone, I may be missing something about the use case, but it looks like there may also be an issue with understanding how YAML and markdown work.

Markdown, when rendered, is converted to HTML as-is. Adding \n in markdown text is equivalent to putting that in an HTML string, which would be stripped.

YAML has several controls that can help you manage paragraphs, by using multi-lines. However, it's important to know the differences between using | and >. Please refer to https://yaml-multiline.info for more information.

However, if I'm missing something about any of your use cases, please provide a fuller example and we'd be happy to look into it.

[webron]

Okay, I take it back. Sorry about that. There is an issue and we're looking into it.

[shockey]

Looks like #5520 solved this 🎉

Input

swagger: "2.0"
paths:
  /:
    get:
      description: "Par 1\n\nPar 2"

Output