Sublime Forum

**ndh** · September 6, 2021, 9:44pm

Displays images inline to enhance comments in code. Sometimes it can be useful to explain something with an image. It detects Markdown-style image links in single line comments: // ![](example.png).

**bitsper2nd** · September 6, 2021, 9:32pm

Thanks , but it doesn’t seem to be working for me on ST4. These are the settings I have set:

// File extensions to enable this plugin for
"extensions": [".md"],

// Maximum width applied to all images.
// NOTE: If your view buffer goes blank, this number is too high.
"img_maxwidth": 1024,

// set to true if you want remote images to be loaded and displayed on_load
"show_remote_images_on_load": true,

// set to true if you want local images to be displayed on_load
"show_local_images_on_load": true,

// set to true if you want local images to display on_post_save
"show_local_images_on_post_save": false,

// set to true if you want remote images to display on_post_save
"show_remote_images_on_post_save": false,

**ndh** · September 6, 2021, 9:44pm

Did you install MarkdownImages? That’s not my plugin.

Try restarting Sublime. It has bugs…

**bitsper2nd** · September 6, 2021, 10:27pm

No. I installed your plugin. Added the github repo first and installed it through package control. I also restarted Sublime Text.

**ndh** · September 7, 2021, 6:13am

Hmm. Well, if you look at this file

github.com

haferburg/Sublime-Inline-Images/blob/main/Inline Images.sublime-settings

{
    // Syntax names to disable this plugin for, e. g. "Plain Text" or "C++".
    "syntax_filter": [],

    // Maximum width applied to all images.
    // NOTE: If your view buffer goes blank, this number is too high.
    "img_maxwidth": 1024,

    // set to true if you want remote images to be loaded and displayed on_load
    "show_remote_images_on_load": false,

    // set to true if you want local images to be displayed on_load
    "show_local_images_on_load": true,

    // set to true if you want local images to display on_post_save
    "show_local_images_on_post_save": true,

    // set to true if you want remote images to display on_post_save
    "show_remote_images_on_post_save": false,

This file has been truncated. show original

there is no "extensions" setting, because I changed it to "syntax_filter". You don’t have my addon. And I believe my addon doesn’t actually work for Markdown. Do you even want my addon?

How exactly did you install it? What do you mean by “added the github repo”? Which one? How did you install through Package Control? I put in a pull request but it didn’t go through yet. My addon is not on Package Control.

Sorry, but I’m super confused. This is the first time I’ve released an addon.

**bitsper2nd** · September 7, 2021, 10:54am

I removed that. Still didn’t work.

I do.

Well that figures.

I have it installed.

Your repository.

I clicked on the green button on github. copied the url. open the command palette. select add repository. paste the url. the rest is history.

**ndh** · September 7, 2021, 1:11pm

Hey, thank you for the detailed reply. Sorry that it’s so difficult to get it to work.

I added Installation instructions. Hope it helps.

I’ve never used Package Control’s Add Repository before. I couldn’t get it to work either with my addon. It says “successfully added”, but it doesn’t seem to do anything.

I hope that the addon will be added to Package Control soon, which should make installation much easier.

**OdatNurd** · September 7, 2021, 1:15pm

This command adds the repository you give it to the list of packages that it knows about; you still have to Package Control: Install Package and choose it from the list to install it.

**ndh** · September 7, 2021, 1:29pm

Oh, nice. That almost works. The plugin is loaded, and loads images.

The URL that I add is https://github.com/haferburg/Sublime-Inline-Images. That causes Package Control to create a Sublime-Inline-Images.sublime-package. However, my addon expects to be called “Inline Images”.

Here’s how I implemented loading the settings:

Is there a way to tell Package Control the name of my addon? Or a better solution for loading the settings file? I could not find documentation of even this ${packages} variable, are there other variables like this?

**OdatNurd** · September 7, 2021, 1:36pm

Packages installed this way indeed take their name from the repository that they come from.

In cases where the name of the repo doesn’t match the name of the package, there needs to be a mapping that tells PC what to name things. One way to do that is in the channel file (where you made your PR) ; there’s a field that you can use to specify the name of the package.

For packages installed this way, you can open the settings for Package Control and include this setting:

	// This helps solve naming issues where a repository it not named the
	// same as the package should be. This is primarily only useful for
	// GitHub and BitBucket repositories. This mapping will override the
	// mapping that is retrieved from the repository channels.
	"package_name_map": {},

It’s empty by default as seen here, but you can use this to map the name of the repository to the name of the package; then when you install, PC will name it correctly.

**ndh** · September 7, 2021, 1:42pm

Hmm, that is not ideal. I wouldn’t want to tell people in the installation instructions that they have to change the PaCo settings…

I tried to add this JSON from my pull request as a channel, because it has a “name” entry.

		{
			"name": "Inline Images",
			"details": "https://github.com/haferburg/Sublime-Inline-Images",
			"releases": [
				{
					"sublime_text": ">=4000",
					"tags": true
				}
			]
		},

But that didn’t work either.

**OdatNurd** · September 7, 2021, 1:45pm

If you add a JSON file, it needs to look like this:

github.com

STealthy-and-haSTy/SublimePackages/blob/master/unreleased-packages.json

{
    "schema_version": "3.0.0",

    "packages": [
        {
            "name": "HyperHelpAuthor",
            "details": "https://github.com/STealthy-and-haSTy/HyperHelpAuthor",
            "releases": [
                {
                    "sublime_text": ">=3092",
                    "tags": true
                }
            ]
        },
        {
            "name": "PythonDocs",
            "details": "https://github.com/gwenzek/PythonDocs",
            "releases": [
                {
                    "sublime_text": ">=4106",

This file has been truncated. show original

If you’re storing it on GitHub, you can provide the URL to the JSON file directly, but use the raw version of the URL. such as is described here: https://github.com/STealthy-and-haSTy/SublimePackages

**ndh** · September 7, 2021, 1:46pm

Hmm I think that’s what I did. Here’s the URL: https://raw.githubusercontent.com/wbond/package_control_channel/ee1147137af40dc666be93d2d7efbb54bf99996f/repository/i.json

**OdatNurd** · September 7, 2021, 3:52pm

To be clear, my comment was meant to mean that you need to include an entire file including the structure outlined, not just the segment that you posted in your question.

It’s also worth pointing out that Package Control won’t list packages that are already installed.

**ndh** · September 8, 2021, 6:02pm

I couldn’t get the channel thing to work, but it doesn’t matter. I’ll just wait for my PR to go through.

With the package_name_map setting I was able to make sure that PaCo is going to work, so that’s very good. Thank you for your help, OdatNurd.

**ndh** · November 19, 2021, 12:46am

Does anybody know why my PR for Package Control is not getting merged? It’s been 10 weeks, and nothing’s happening. Did I do something wrong? Did I miss something?

**michaelblyons** · November 19, 2021, 1:28am

No, it’s just that reviewing is a slow, rarely appreciated task. Yours may be particularly dicey because it automatically downloads arbitrary resources from the big-I Internet. I don’t know what the implications might be if it was a malicious URL.

Don’t get me wrong, your package is neat. I’m just speculating about why it might be taking longer than other packages that could be easier to review.

**UltraInstinct05** · November 19, 2021, 1:49am

To add to those facts, all of the reviewing is voluntary work done by the members of the community in their free time. No one is paid a full time salary to work on reviewing packages. So I guess you need to have lots of patience as well and wait for the review to complete.

**UltraInstinct05** · November 19, 2021, 9:21am

I added some improvements points for the package. Note that I don’t have permissions to accept packages, but thought I’d help with reviewing it.