Join GitHub today
Support Inline Markdown Documentation #185
Version and Environment Details
Operation system: macOS High Sierra 10.13.5
IDE name and version: WebStorm 2018.2.5
Plugin version: 1.7.2
Inline markdown comments with double quotes (single-line) and triple double quotes (multi-line) which
Inline markdown comments are considered an error:
And syntax highlighted as errors:
Steps to Reproduce / Link to Repo with Reproduction and Instructions
Thanks for using the plugin.
Documentation in quotes/tripe quotes was a breaking language change that was added to the GraphQL spec after the V1.x parser and language service for this plugin was built. V1 expects documentation to be in
V2 of this plugin follows that newer language spec, but is still work in progress. Currently V2 shows documentation in completions, but the quick documentation viewer found in V1 is yet to be built.
You can read more about V2 in #164 and https://github.com/jimkyndemeyer/js-graphql-intellij-plugin/releases and try it out if you prefer to use quotes for the documentation.
I'll keep this issue around as markdown support would be a nice addition to V2.