Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/leonid-shevtsov/ClickableUrls_SublimeText

Underlines URLs in Sublime Text, and lets you open them with a keystroke.
https://github.com/leonid-shevtsov/ClickableUrls_SublimeText

Last synced: 15 days ago
JSON representation

Underlines URLs in Sublime Text, and lets you open them with a keystroke.

Host: GitHub
URL: https://github.com/leonid-shevtsov/ClickableUrls_SublimeText
Owner: leonid-shevtsov
License: mit
Archived: true
Created: 2012-10-15T09:58:09.000Z (about 12 years ago)
Default Branch: master
Last Pushed: 2023-01-27T16:12:14.000Z (almost 2 years ago)
Last Synced: 2024-08-01T05:23:49.504Z (3 months ago)
Language: Python
Homepage:
Size: 39.1 KB
Stars: 154
Watchers: 11
Forks: 19
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# Project is discontinued!

I'm not using Sublime Text anymore and have no interest in supporting this project.

If you want to carry on, you have my full permission - and gratitude!

# Clickable URLs

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

![Screenshot of a clickable URL](https://raw.github.com/leonid-shevtsov/ClickableUrls_SublimeText2/master/screenshot.png)

**Breaking change! The `open_url` command is named `open_url_under_cursor` since v1.3.0 to avoid conflict with the built-in command with the same name. Please update your configuration if you've made custom bindings.**

## Summary

This plugin underlines URLs in Sublime Text, and lets you open them with a keystroke (`Cmd+Option+Enter` by default).

After you put the cursor over an URL, you can either hit `Cmd+Option+Enter` (`Ctrl+Alt+Enter` on Windows & Linux), or select "Open URL under cursor" from the Command Palette. Instead of selecting an auto detected URL, you can select any block of text and it will also open in a browser as a URL.

If you actually want to use a mouse+key combination to open URLs, you'll have to part with one of the selection modes (likely the Option-selection, which is rectangular block selection and is not used very often). See [this issue](https://github.com/leonid-shevtsov/ClickableUrls_SublimeText2/issues/2) for details and examples on how to do it. Unfortunately Sublime Text's API is not flexible with mouse bindings.

There is also an "Open all URLs" command, which opens all URLs found in the current document.

**Performance warning.** The plugin is automatically disabled if the document has more than 200 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](http://wbond.net/sublime_packages/package_control) (look for Clickable Urls), or just drop the plugin into Sublime Text's Packages folder.

## Configuration

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

To rebind mouse keys, open `Preferences > Package Settings > Clickable URLs > Mouse Bindings - User`

### Customising the browser

By default, Clickable URLs uses some default system browser. If it doesn't work for you, you can change the browser by setting the `clickable_urls_browser` in the `ClickableUrls.sublime-settings`
file, to which you can get from the menu.

Anything from [this list](https://docs.python.org/2/library/webbrowser.html#webbrowser.register) will work, for example:

{
"clickable_urls_browser": "firefox"
}

**Note for Windows users.** If the browser you want won't open, you might have to specify the full path manually:

{
"clickable_urls_browser": "\"c:\\program files\\mozilla firefox\\firefox.exe\" %s &"
}

Take note of the escaped slashes and the quoting around the name.

The ampersand at the end is significant - without it the editor will hang and wait for browser to close.

### 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_urls` to false.

{
"highlight_urls": 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 ClickableUrls works as usual.

---