Vscode-vsce: Add images to readme without having a repository

[psclkhoury]

Hey,

I am writing a vscode extension that is intended to be used only by my team, so I cannot publish it to the marketplace, or have it in a repo other than our own servers (company policies).

I would like to add an icon to the extension and some pictures and gifs to the Readme but vsce won't package the extension into a vsix if I don't provide a repo link.

Is there a way to get around that?

[joaomoreno]

What's the error you're getting?

[psclkhoury]

@joaomoreno I have a local gif that I want to add to the readme and I have no repository specified in the package.json

![extension demo](demo.gif)

And this is the error that I get:

ERROR Couldn't detect the repository where this extension is published. The image 'demo.gif' will be broken in README.md. Please provide the repository URL in package.json or use the --baseContentUrl and --baseImagesUrl options.

[joaomoreno]

Have you tried passing --baseContentUrl and --baseImagesUrl?

  --baseContentUrl [url]  Prepend all relative links in README.md with this url.
  --baseImagesUrl [url]   Prepend all relative image links in README.md with this url.

[psclkhoury]

I tried, but as I said, I dont have URLs to append.

My repo looks like this:

I want to use demo.gif inside the README.md and distribute the vsix, without having any repo or urls.

Is that possible or vscode doesnt support showing images in the README.md that are not from some url.

[joaomoreno]

If you have no URLs to append simply add --baseContentUrl none and --baseImagesUrl none as a workaround for now.

[psclkhoury]

Also tried that, doesn't work. I get this error when running vsce package --baseContentUrl none --baseImagesUrl none

ERROR Images in README.md must come from an HTTPS source: none/demo.gif

[joaomoreno]

Oh, then use https://none instead.

[psclkhoury]

Now I get a broken image in the README when I install the extension.

This is just a waste of time. I'm gonna close this. Probably vscode only supports images in README coming from a repository.

[joaomoreno]

Yeah, VS Code supports images in README coming from a URL only, unfortunately.

If you want we can open up a feature request to allow this, but it seems like overload for a private extension.

[psclkhoury]

@joaomoreno I don't know if it is an overload, because visual studio has a mechanism to distribute self hosted extensions via private galleries. That way you always get update notifications even if the extension is not published in the martketplace.

Unfortunately, vscode doesn't have something similar as far as I can tell, so now it's a big hassle to write private extensions and distribute them.

Hopefully they will add this soon.

Thank you for your help

[joaomoreno]

Unfortunately, vscode doesn't have something similar as far as I can tell, so now it's a big hassle to write private extensions and distribute them.

Is there anything else not working, besides images?

[psclkhoury]

Actually there already is a feature request for that here

Is there anything else not working, besides images?

Nope that was the only thing that I was missing for now. Thanks

[whlkw]

VS Code still supports images in README coming from a URL only?

[JonathanCrossland]

Wow, you cant put a few images in the vsix package and use in readme?

EDITED:
This isn't a limitation of vsix as it appears you can embed assets.
https://docs.microsoft.com/en-us/visualstudio/extensibility/vsix-manifest-designer?view=vs-2019

And I would imagine this to be pretty easy with VSCode presenting the readme.md

Is this a limitation of marketplace to extract and view the readme?