Skip to content
This repository was archived by the owner on Feb 21, 2020. It is now read-only.
This repository was archived by the owner on Feb 21, 2020. It is now read-only.

Markdown not rendered properly #11

Description

@theopak

We got this feedback:

I noticed that in developer.cimpress.io, services that use markdown in text fields in their swagger doc don’t get rendered properly:

Just wanted to let you know about this – I believe markdown is supported in swagger in general. The impact this has for us is, when we point potential clients at our API docs, we end up pointing them at the ones served by the service itself, rather than on the portal. If this is something we could fix it would avoid that, and I’d point them at the portal.

It's absolutely true that Swagger Spec 2.0 (aka OpenAPI Spec 2.0) allows GFM (Github Flavored Markdown) according to http://swagger.io/specification/, and that this project currently doesn't render markdown in all cases.

We should update swagger-ui-cimpress to treat all descriptions as Github Flavored Markdown and render it as such.

@hsingh23 I see that you added this block which seems to pick whether to interpret a display string as either HTML or Markdown: https://github.com/Cimpress-MCP/swagger-ui-cimpress/blob/master/src/main/javascript/view/MainView.js#L78

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions