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

Replace HTML with markdown #7

Closed
rbren opened this issue Jul 2, 2015 · 2 comments
Closed

Replace HTML with markdown #7

rbren opened this issue Jul 2, 2015 · 2 comments

Comments

@rbren
Copy link
Contributor

rbren commented Jul 2, 2015

https://github.com/domchristie/to-markdown

HTML tends to show up in api.info.description, parameter.description, etc

@IvanGoncharov
Copy link
Member

According to Swagger 2.0 spec:

A short description of the application. GFM syntax can be used for rich text representation.

And GFM support subset of html.

But I agree that HTML support unnecessarily complicate client side and if possible should be converted.
I will review this tool and if it provides accurate conversion than I will use it.

@MikeRalphson
Copy link
Collaborator

Most tools rendering Markdown will use a markdown-to-html converter where the embedded html will be passed-through. All OpenAPI 2/3 compatible tools will need to support html in descriptions, so I don't think we would be achieving much by this.

Please shout if there is a markdown-to-text use-case which doesn't support HTML.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants