This extension supports navigating to documentation from the following programming languages:
Javascript (js)
React (jsx)
Typescript (ts)
Typescript React (tsx)
Keybindings
By default, ctrl+shift+r (or cmd+shift+r on mac) is bound as a shortcut to show the documentation for a module, if the cursor is currently touching that module name.
If you wish to change the key binding for this behavior, do the following:
File -> Preferences -> Keyboard Shortcuts
Search for "nodeReadme"
Click on the pencil icon to edit
Custom documentation
If you wish to override the documentation that will be provided for a specific module, you can do so using extension settings.
File -> Preferences -> Settings
Search for "nodeReadme"
Override nodeReadme.overrides with an object containing your custom documentation overrides indexed by module name
This will load the specified file or module documentation rather than the official README.md from the original module.
Release Notes
Here's a running list of recent changes! :sparkles:
3.0.2
Fixed semver issue
3.0.1
Updated description
Fixed Readme Emojis
3.0.0
Better documentation
Automated tests
Refactor to support easier testing
Dropped support for older vscode versions
Requires ^1.18.0 now
2.3.0
Semver npm lookup bugfix (shoutout to @CallMeLaNN)
