For a project symbol or for a symbol from the project dependencies, RubyMine generates the documentation from the corresponding JSDoc comment.
If no comment is found in the d.ts files, RubyMine shows a summary from the corresponding MDN article.
View documentation for a symbol
Position the caret at the symbol and press Ctrl+Q or selectfrom the main menu.
When you hover the mouse pointer over a symbol, RubyMine immediately displays the reference for it in the Documentation popup.
You can turn off this behavior or configure the popup to appear faster or slower, see Configuring the behavior of Documentation popup below.
Configure the behavior of Documentation popup
To turn off showing documentation automatically, open the Settings/Preferences dialog Ctrl+Alt+S, go to , and clear the Show quick documentation on mouse move checkbox.
To have the Documentation popup shown faster or slower, open the Settings/Preferences dialog Ctrl+Alt+S, go to , then select the Show the documentation popup checkbox and specify the delay time.
View the MDN documentation for symbols
In the Documentation popup Ctrl+Q, click the link at the bottom:
Press Shift+F1 or selectfrom the main menu.
RubyMine opens the MDN article in the default RubyMine browser.
Position the caret at the symbol in question and press Shift+F1 or choosefrom the main menu.
View documentation for npm packages
In a package.json file or in a
importstatement, position the caret at the name of the package and press Ctrl+Q
To open the documentation on the npm official website in the browser, press Shift+F1.
View reference in a tool window
Pin the Documentation popup. It turns into the Documentation tool window, with the corresponding sidebar icon and more controls.
To switch between the Documentation popup and the Documentation tool window, press Ctrl+Q sequentially.
Change the font size of quick documentation
Click in the upper-right corner of the quick documentation window, and move the slider.
In the Settings/Preferences dialog Ctrl+Alt+S, go to and select the Change font size (Zoom) with Ctrl+Mouse Wheel checkbox. See Useful editor configurations for details.