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

TypeScript Definitions to Markdown
https://github.com/skarab42/ts-to-md

markdown types typescript vscode vscode-extension

Last synced: about 2 months ago
JSON representation

TypeScript Definitions to Markdown

• Host: GitHub
• URL: https://github.com/skarab42/ts-to-md
• Owner: skarab42
• License: mit
• Created: 2021-08-25T13:54:36.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-06T09:23:29.000Z (over 1 year ago)
• Last Synced: 2024-06-28T06:35:38.999Z (3 months ago)
• Topics: markdown, types, typescript, vscode, vscode-extension
• Language: TypeScript
• Homepage:
• Size: 243 KB
• Stars: 35
• Watchers: 3
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# TypeScript Definitions to Markdown

[![integration](https://github.com/skarab42/ts-to-md/actions/workflows/integration.yml/badge.svg)](https://github.com/skarab42/ts-to-md/actions/workflows/integration.yml)

TypeScript Definitions to Markdown (ts-to-md) is a VS Code extension that helps you to export your TypeScript definitions in Markdown format directly to your clipboard ready to paste in your README.

![GIF](https://user-images.githubusercontent.com/62928763/131223948-95c8ce18-400f-43d5-bf05-e6bf60ef5945.gif)

## Features

- Exports Type and Interface.

- Outputs Markdown table (or list).

- Take care of BlockDoc comments.

- Bring default value from TSDoc @default tag.

- Also works with unsaved or scratch file.

- Uses your local/global typescript version.

- Fallback to embedded typescript version.

- Set a custom fixed version of typescript.

_Planned_

- Markdown list output.

- ...

## Installation

Install through VS Code Marketplace: [TypeScript Definitions to Markdown](https://marketplace.visualstudio.com/items?itemName=skarab42.ts-to-md).

## Usage

Right click on any type or interface and search for `TS Definitions to Markdown` in the contextual menu next to copy/paste or use the command palette `Ctrl+Shift+P` and search 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