Table of contents

• Instant Documentation VSCode Extension
  • Installation in VS Code
    • Install from VS Code (Recommended)
    • Install from GitHub
  • VSCode Settings
  • Configuration file
    • Options
  • Keybindings

Instant Documentation VSCode Plugin

A VSCode extension that will show on-the-fly documentation for typescript and javascript files

Installation in VS Code

Install from VS Code (Recommended)

Open VSCode, search for instant-documentation-vscode in Extensions, and then click the Install button.

Install from GitHub

Download instant-documentation-vscode-x.xx.x.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 Instant 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 of 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 i or ctrl-k i	Open Instant Documentation