@structured-types/vscode-plugin v3.32.0
Table of contents
A VSCode extension that will show the structured type information documentation for typescript and javascript files
Installation in VS Code
Install from VS Code (Recommended)
Open VSCode, search for @structured-types/vscode-plugin
in Extensions and then click the Install button.
Install from GitHub
Download @structured-types/vscode-plugin-_.vsix
file from Releases.
Open vscode, run Extension: Install from VSIX, then choose the _.vsix file you just downloaded.
VSCode Settings
You can go to the Preferences/Settings/Extensions is VSCode and then select the Structured Documentation tab.
Configuration file
You can also use an external configuration file as documented in @structured-types/api-docs
Options
singlePage
: Open only one documentation page, instead a new one for every file.autoShowDocumentation
: Automatically show a documentation page of the code being edited.
And the other options are from @structured-types/api-docs
DocumentOptions
Keybindings
The cmd key for Windows is ctrl.
Shortcuts | Functionality |
---|---|
cmd-k v or ctrl-k v | Open documentation to the Side |
cmd-shift-v or ctrl-shift-v | Open documentation |