Skip to content
| Marketplace
Sign in
Visual Studio Code>Programming Languages>TypeDoc Live PreviewNew to Visual Studio Code? Get it now.
TypeDoc Live Preview

TypeDoc Live Preview

Peter Šulek

|
2,907 installs
| (3) | Free
Display live preview of typescript documentation (tsdoc or typedoc)
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Copied to clipboard
More Info

TypeDoc Live Preview for Visual Studio Code

A vscode extension to show live preview of typescript documentation using tsdoc or typedoc markup within your typescript files.

Features

Light & dark theme support (autodetect)

Theme (light or dark) is automatically detect from vscode theme.

Show/hide empty signatures

Show or hide methods/fuctions with no documentation signatures.

Commands

Command Keybinding
TypeDoc Live Preview: Open Preview to the Side Ctrl + Alt + P
TypeDoc Live Preview: Reload Preview none
TypeDoc Live Preview: Show empty signatures none
TypeDoc Live Preview: Hide empty signatures none
TypeDoc Live Preview: Refresh Typescript library types cache none

Install

  1. Open Extensions sideBar panel in Visual Studio Code and choose the menu options for View → Extensions
  2. Search for typedoc-live-preview
  3. Click Install
  4. Click Reload, if required

Marketplace

Marketplace extension page - TypeDoc Live Preview

Configuration

This extension contributes the following settings:

Setting Description Default Values
typedoclivepreview.emptySignatures Show or hide empty methods/fuctions signatures show show,hide

Release Notes

Have a look at our CHANGELOG to get the details of all changes.

1.0.1

Added support for Typescript react (tsx) files

1.0.0

Initial release of TypeDoc Live Preview extension

  • Contact us
  • Jobs
  • Privacy
  • Manage cookies
  • Terms of use
  • Trademarks
© 2025 Microsoft