link.vim

Warning

This plugin now supports not only Markdown links, but also plaintext links, hence the renaming of the plugin. This update includes several breaking changes, so please read this document and :help link.

link.vim is a plugin for Vim and Neovim that keeps long URLs out of your way. It supports links in Markdown syntax and plaintext links (e.g. in emails, in text files etc.)

Inline links will be moved to a reference section. For instance, the following Markdown document:

# Notes

[Vim](https://www.vim.org) and [Neovim](https://neovim.io) are text editors.

will be turned into

# Notes

[Vim][0] and [Neovim][1] are text editors.

## Links

[0]: https://www.vim.org
[1]: https://neovim.io

Watch the screencast for a quick overview of the plugin:

screencast.mp4

Installation

Use your favorite plugin manager to install this plugin. For instance, if you use vim-plug:

Plug 'qadzek/vim.link'

Usage

By default, this plugin is activated for Markdown, Vimwiki, email and text files. You can customize the filetypes on which the plugin operates in your vimrc:

let g:link_enabled_filetypes = [ 'markdown', 'gitcommit' ]

link.vim can be used by executing one of the following commands:

Command	Key binding	Description
:LinkConvertSingle	LocalLeader + c	Convert link under cursor
	<C-g> + c	Same, but from insert mode
:LinkConvertRange	LocalLeader + c	Convert links on visually selected lines
:LinkConvertAll	LocalLeader + a	Convert all links in document
:LinkJump	LocalLeader + j	Jump to and from reference section
:LinkOpen	LocalLeader + o	Open link in browser
:LinkPeek	LocalLeader + p	Show link preview
:LinkReformat	LocalLeader + r	Renumber/merge/delete unneeded links

No mappings are built-in to avoid conflicts with your existing key bindings. You can enable the key bindings suggested above by adding this line to your vimrc:

let g:link_use_default_mappings = 1

Note that by default, <LocalLeader> is the backslash key. Run :help link-mappings to view how to change these key bindings.

Read :help link-configuration to learn how to customize the heading, the position of the reference section, which lines to skip and more.

The Wiki contains some snippets submitted by users, showing configuration for e.g. gitcommit buffers.

Misc

Questions, suggestions, comments, feature requests... everything is welcome in the Issues tab.

If you would like to contribute, see :help link-contributing.