<commit_before>﻿# Remote Images Preview
Sublime Text Plugin for previewing remote images.

A plugin for [Sublime Text 2 and 3](http://sublimetext.com)

## Summary

This plugin underlines remote image URLs in Sublime Text, and lets you preview the images simply by hovering on their URLs.

**Performance warning.** The plugin is automatically disabled if the document has more than 200 remote image URLs, in order to avoid a massive performance hit. To change this number, set the `max_url_limit` option (see "Configuration" below). 

## Installation

_macOS_
```
cd ~/Library/Application\ Support/Sublime\ Text\ 3/Packages
git clone --depth=1 https://github.com/royneau/remote-images-preview.git
```

_Ubuntu_
```
cd ~/.config/sublime-text-3/Packages
git clone --depth=1 https://github.com/royneau/remote-images-preview.git
```

_Windows_
```
cd "%APPDATA%\Sublime Text 3\Packages"
git clone --depth=1 https://github.com/royneau/remote-images-preview.git
```

Or manually create a folder named "remote-images-preview" on your Sublime Text's Packages folder and copy the content of this repo to it.

## Configuration

All configuration is done via the settings file that you can open via the main menu: `Preferences > Package Settings > Remote Images Preview > Settings - User`.

### Disabling URL highlighting

Unfortunately, the only way to underline a block of text in Sublime Text 2 is a hack with underlining empty regions, and there is no way to control its appearance. If you want, you can disable URL highlighting by setting the option `highlight_images` to false.

    {
        "highlight_images": false
    }

Note that this isn't an issue with Sublime Text 3.

## Known Issues

* URLs are not underlined in Markdown files when using the [MarkdownEditing plugin](https://github.com/SublimeText-Markdown/MarkdownEditing) plugin (that plugin applies its own styles to the URLs). Otherwise RemoteImagesPreview works as usual.

* * *

(c) 2017 [royneau](https://github.com/royneau) under the MIT license.
<commit_msg>docs: update the installation intructions<commit_after>﻿# Remote Images Preview
Sublime Text Plugin for previewing remote images.

A plugin for [Sublime Text 2 and 3](http://sublimetext.com)

## Summary

This plugin underlines remote image URLs in Sublime Text, and lets you preview the images simply by hovering on their URLs.

**Performance warning.** The plugin is automatically disabled if the document has more than 200 remote image URLs, in order to avoid a massive performance hit. To change this number, set the `max_url_limit` option (see "Configuration" below). 

## Installation

### With Package Control

In the Command Palette, use the `Package Control: Add Repository` option and enter this URL: https://github.com/royneau/remote-images-preview.

### With Git

_macOS_
```
cd ~/Library/Application\ Support/Sublime\ Text\ 3/Packages
git clone --depth=1 https://github.com/royneau/remote-images-preview.git
```

_Ubuntu_
```
cd ~/.config/sublime-text-3/Packages
git clone --depth=1 https://github.com/royneau/remote-images-preview.git
```

_Windows_
```
cd "%APPDATA%\Sublime Text 3\Packages"
git clone --depth=1 https://github.com/royneau/remote-images-preview.git
```

### Manually

Create a folder named "remote-images-preview" on your Sublime Text's Packages folder and download the content of this repo to it.

## Configuration

All configuration is done via the settings file that you can open via the main menu: `Preferences > Package Settings > Remote Images Preview > Settings - User`.

### Disabling URL highlighting

Unfortunately, the only way to underline a block of text in Sublime Text 2 is a hack with underlining empty regions, and there is no way to control its appearance. If you want, you can disable URL highlighting by setting the option `highlight_images` to false.

    {
        "highlight_images": false
    }

Note that this isn't an issue with Sublime Text 3.

## Known Issues

* URLs are not underlined in Markdown files when using the [MarkdownEditing plugin](https://github.com/SublimeText-Markdown/MarkdownEditing) plugin (that plugin applies its own styles to the URLs). Otherwise RemoteImagesPreview works as usual.

* * *

(c) 2017 [royneau](https://github.com/royneau) under the MIT license.

{'fraction_non_alphanumeric': 0.08818011257035648, 'fraction_numerical': 0.00797373358348968, 'mean_word_length': 4.358040201005025, 'pattern_counts': {'":': 2, '<': 3, '<?xml version=': 0, '>': 9, 'https://': 11, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4567013', 'n_tokens_mistral': 1264, 'n_tokens_neox': 1178, 'n_words': 518}