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 2K
  • Win 1K
  • Mac 744
  • Linux 462
Sep 29 Sep 28 Sep 27 Sep 26 Sep 25 Sep 24 Sep 23 Sep 22 Sep 21 Sep 20 Sep 19 Sep 18 Sep 17 Sep 16 Sep 15 Sep 14 Sep 13 Sep 12 Sep 11 Sep 10 Sep 9 Sep 8 Sep 7 Sep 6 Sep 5 Sep 4 Sep 3 Sep 2 Sep 1 Aug 31 Aug 30 Aug 29 Aug 28 Aug 27 Aug 26 Aug 25 Aug 24 Aug 23 Aug 22 Aug 21 Aug 20 Aug 19 Aug 18 Aug 17 Aug 16 Aug 15
Windows 2 8 4 3 2 6 3 9 4 1 3 4 4 11 10 8 4 3 8 7 4 2 4 6 1 8 5 1 4 4 2 1 4 4 2 4 6 2 4 7 0 6 2 6 2 4
Mac 3 1 1 1 1 3 3 2 2 3 1 8 5 4 5 6 4 0 5 3 5 3 2 1 0 0 5 6 3 2 0 1 4 3 4 4 1 2 1 3 2 3 3 2 2 3
Linux 2 2 2 1 0 3 2 5 1 1 1 2 2 0 0 1 1 0 2 2 2 4 6 0 1 2 2 4 2 1 1 0 0 5 3 0 3 4 0 0 6 0 1 2 0 1

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.

Limitations

Sublime's markdown parser only recognizes an image URL if these conditions are met: - There is no whitespace in the URL or filepath. - The “alt text” section of the image markup is not empty (it can have whitespace).

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