psulek / vscode-typedoc-livepreview

Live preview of typescript documentation (typedoc)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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.0

Initial release of TypeDoc Live Preview extension

About

Live preview of typescript documentation (typedoc)

License:MIT License


Languages

Language:TypeScript 93.4%Language:CSS 2.8%Language:HTML 2.4%Language:JavaScript 1.3%