TypeDoc Live Preview for Visual Studio Code
![](https://github.com/psulek/vscode-typedoc-livepreview/blob/main/docs/demo/demo1.gif?raw=true)
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.
![](https://github.com/psulek/vscode-typedoc-livepreview/blob/main/docs/demo/demo2.gif?raw=true)
Show/hide empty signatures
Show or hide methods/fuctions with no documentation signatures.
![](https://github.com/psulek/vscode-typedoc-livepreview/blob/main/docs/demo/demo3.gif?raw=true)
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
- Open Extensions sideBar panel in Visual Studio Code and choose the menu options for View → Extensions
- Search for
typedoc-live-preview
- Click Install
- 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
| |