TypeScript Definitions to Markdown

TypeScript Definitions to Markdown (ts-to-md) is an VS Code extension that help you to export your TypeScript definitions in Mardown format directly in your clipboard ready to past in your README.

GIF

Features

Exports Type and Interface
Extends, Omit, Partial...
Indexed/Numbered index
Nested definitions
Markdown table output

Planned

Markdown list output
Configurable
...

Installation

Install through VS Code Marketplace: TypeScript Definitions to Markdown.

Usage

Right click on any type or interface and search for TS Definitions to Markdown in contextual menu next to copy/past or use the command palet Ctr+Shift+P and serach for the same command name.

Known issues and limitations

https://github.com/skarab42/ts-to-md/issues

Contributing

https://github.com/skarab42/ts-to-md/pulls