ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Markdown Images

by xsleonard ALL

Sublime Text 3 plugin to render images in markdown files

Details

Installs

  • Total 266
  • Win 135
  • Mac 81
  • Linux 50
Feb 28 Feb 27 Feb 26 Feb 25 Feb 24 Feb 23 Feb 22 Feb 21 Feb 20 Feb 19 Feb 18 Feb 17 Feb 16 Feb 15 Feb 14 Feb 13 Feb 12 Feb 11 Feb 10 Feb 9 Feb 8 Feb 7 Feb 6 Feb 5 Feb 4 Feb 3 Feb 2 Feb 1 Jan 31 Jan 30 Jan 29 Jan 28 Jan 27 Jan 26 Jan 25 Jan 24 Jan 23 Jan 22 Jan 21 Jan 20 Jan 19 Jan 18 Jan 17 Jan 16 Jan 15
Windows 6 8 8 9 8 6 3 5 4 4 2 11 4 7 4 7 4 5 8 4 9 4 9 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Mac 3 5 3 6 2 2 4 0 4 5 4 4 3 3 2 8 6 3 4 2 1 4 4 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Linux 1 0 0 3 1 0 1 4 2 5 2 4 1 1 1 4 1 3 2 1 3 4 5 2 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Readme

Source
raw.​githubusercontent.​com

Markdown Images

This is a Sublime Text 3 plugin to render images inside of markdown files.

Example

Usage

Images in markdown use the ![alt text](uri) markup. Wherever this appears, this plugin can render the image specified by the URI below the line.

You can configure an image's dimensions by adding HTML <img> properties after the image markup: ![alt text](uri){width="200", height="200"}. Everything between the {} will be copied to the <img> element that renders the image.

If the URI points to a file on disk, it is called a “local” image, and renders by default. If the URI points to an external (http, https, etc) resource, it is called a “remote” image, and does not render by default.

You can choose to show local, show remote or show all images from the command palette and with the configuration settings.

Configuration

By default, images are rendered when the file is first loaded. This can be configured with the show_local_images_on_load and show_remote_images_on_load settings.

Images can rendered on save with the show_local_images_on_post_save and show_remote_images_on_post_save settings.

Go to Sublime Text -> Packages -> Package Settings -> MarkdownImages (macOS menu) to edit your configuration.

Refer to the default configuration file.

Commands

  • markdown_images_show(show_local: bool, show_remote: bool) - Show images from the local filesystem and/or remote URLs
  • markdown_images_hide() - Removes all rendered images from the view

These can be activated with the command palette (cmd+shift+p):

  • MarkdownImages: Hide Images
  • MarkdownImages: Show All Images
  • MarkdownImages: Show Local Images
  • MarkdownImages: Show Remote Images

Keybindings

This plugin adds no keybindings. You can set your own keybindings to the commands.

Notes

The URI portion of the ![alt text](uri) markup must not contain spaces or else the markdown syntax parser (provided by other packages) will not recognize this as image markup.

Only PNG, JPG and GIF images are supported.

SVG does not render inside of ST3 Phantom objects, unfortunately.

Remote image loading runs in the main thread so it will stall ST3. Remote image loading is disabled

Credits

The image rendering code was seeded by sublime_zk