Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/robertohuertasm/vscode-marketplace-preview

πŸ§ΊπŸ”Ž Preview how the manifest of your extension will look in the Visual Studio Marketplace
https://github.com/robertohuertasm/vscode-marketplace-preview

extension preview visual-studio-code vscode vscode-extension

Last synced: 5 days ago
JSON representation

πŸ§ΊπŸ”Ž Preview how the manifest of your extension will look in the Visual Studio Marketplace

Awesome Lists containing this project

README

        



logo

Marketplace Preview

Easily preview how your Visual Studio Code extension will look like in the marketplace



[![Version](https://img.shields.io/visual-studio-marketplace/v/robertohuertasm.vscode-marketplace-preview.svg?style=for-the-badge&colorA=252525&colorB=0079CC)](https://marketplace.visualstudio.com/items?itemName=robertohuertasm.vscode-marketplace-preview)
[![Installs](https://img.shields.io/visual-studio-marketplace/i/robertohuertasm.vscode-marketplace-preview.svg?style=for-the-badge&colorA=252525&colorB=0079CC)](https://marketplace.visualstudio.com/items?itemName=robertohuertasm.vscode-marketplace-preview)
[![Downloads](https://img.shields.io/visual-studio-marketplace/d/robertohuertasm.vscode-marketplace-preview.svg?style=for-the-badge&colorA=252525&colorB=0079CC)](https://marketplace.visualstudio.com/items?itemName=robertohuertasm.vscode-marketplace-preview)
[![Ratings](https://img.shields.io/visual-studio-marketplace/r/robertohuertasm.vscode-marketplace-preview.svg?style=for-the-badge&colorA=252525&colorB=0079CC)](https://marketplace.visualstudio.com/items?itemName=robertohuertasm.vscode-marketplace-preview)


![demo](https://raw.githubusercontent.com/robertohuertasm/vscode-marketplace-preview/master/resources/images/demo.gif)

## Features

This extension will allow you to preview how your extension will look like in the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/vscode).

This can be very convenient as there no easy way to do that and most of the time you have to wait for your extension to be published to then realize that the readme didn't look as you expected.

## How it works?

The extension will only be enabled if a `package.json` file is present in your folder.

If that's the case, a new command will be available to you:

```sh
# Ctrl/Cmd+Shift+P or F1
Marketplace: Preview Manifest
```

> Bear in mind that this command will only be available when the `package.json` file is active on VSCode. Note that you will also neeed a `README.md` file for the content to be properly previewed.

Aside from the command, you will also see a new icon in the top left corner of your `package.json` file:

![icon](https://raw.githubusercontent.com/robertohuertasm/vscode-marketplace-preview/master/resources/images/docs_icon.png)

If you press it, you'll see that a new preview panel opens showing you a preview of how your extension would look like.

## Preview your changes

Once you have the `Preview Panel` opened, you'll be able to modify both your `package.json` and `README.md` files. The changes will be updated in the `Preview Panel` every time you save the changes.