JetBrains offers Reader Mode that renders documentation comments when viewing source files. I thought adding this to GraphQL SDL files could improve the schema author experience.
Desired behavior
Descriptions (doc comments, " and """) would respect Reader Mode and associated behavior (toggle rendered or not, etc). When in reader mode, the doc comments would display with the Markdown rendered.
Workarounds
In the mean-time, I have "CMD-clicked" the type definition or field, which brings up the documentation popover. Thank you so much for this feature!
However, reader mode offers additional value because (a) it saves a click, (b) developers can enable it by default (which can even show markdown/typographic issues), and (c) links could (hopefully) become clickable (I could not figure out how to open a link/href from the popover.)
Feature request
Integrate with Reader Mode.
JetBrains offers Reader Mode that renders documentation comments when viewing source files. I thought adding this to GraphQL SDL files could improve the schema author experience.
Desired behavior
Descriptions (doc comments,
"and""") would respect Reader Mode and associated behavior (toggle rendered or not, etc). When in reader mode, the doc comments would display with the Markdown rendered.Workarounds
In the mean-time, I have "CMD-clicked" the type definition or field, which brings up the documentation popover. Thank you so much for this feature!
However, reader mode offers additional value because (a) it saves a click, (b) developers can enable it by default (which can even show markdown/typographic issues), and (c) links could (hopefully) become clickable (I could not figure out how to open a link/href from the popover.)
Other notes
ReaderModeMatcherandReaderModeProvider