graphdoc icon indicating copy to clipboard operation
graphdoc copied to clipboard

Apply Markdown processing to ALL instances of descriptions

Open skyzyx opened this issue 8 years ago • 1 comments

I make heavy use of Markdown in my GraphQL documentation. Some tools get this right, while others have odd gaps in support. For example, even GraphiQL leaves some Markdown unprocessed.

It would be nice if all descriptions were processed with Markdown to generate HTML. If HTML output isn't appropriate, then do Markdown → HTML generation, followed by stripping HTML tags from the output.

This would provide a cleaner experience with the text.

skyzyx avatar Sep 30 '17 00:09 skyzyx

Of note, graphql spec expects documentation to be rendered with CommonMark.

https://graphql.github.io/graphql-spec/June2018/#sec-Documentation

seanb4t avatar Jul 08 '19 15:07 seanb4t