This vim plugin automatically finds and inserts URLs for links in Markdown and ReST documents.
Search for URLs
For example, say you have this document:
I think [Markdown] is really great. [Markdown]: need a URL for this
With your cursor on the last line, you can type
auto-complete link) and the last line will become:
Behind the scenes, the plugin searches on Blekko for the word "Markdown" and
inserts the first result's URL, a reasonable guess for a relevant link on the
subject, in the appropriate place. This also works in ReST documents on
hyperlink target lines like
.. _Markdown: link goes here.
Create Link Definitions
This plugin can help you insert the markup for reference-style links. For example, suppose you have just typed this paragraph:
I prefer the [vim text editor][vim].
<leader>am (for auto-make link) to add a definition for the link
below the current paragraph:
I prefer the [vim text editor][vim]. [vim]:
This also works in ReST for reference-style links like
The plugin is careful to insert newlines between text paragraphs and blocks of link references to make your document look nice.
All Together Now
To insert and complete a link definition in one fell swoop, use
(for auto-link, the name of this plugin). This will add a reference to your
link after the current paragraph, fill it out with a search result, and then
jump back to your current cursor position to let you keep writing. (If your leader is
\, then it's like typing
The plugin requires vim to be built with Python bindings (to communicate with
the Blekko API). If you're using Pathogen, just clone this repository into
your bundles directory (and run
:Helptags). Otherwise, place files in
doc into the corresponding directories in
- Automatic activation when completing a link reference (i.e., after typing
- Optionally use the link text, rather than the reference ID, as the search terms.
- Options to use subsequent results (if the first link isn't good).
- Handle web service errors (avoid inserting "None", possible retry).
- Add to the vimscripts directory.
This plugin is by me, Adrian Sampson. This is my first bit of vimscript hackery and is very experimental---I apologize for weirdnesses arising from my unfamiliarity with writing vim plugins.
The code is available under the MIT license. The plugin contains an inlined copy of python-blekko, which is under the same license. My thanks to the kind folks at Blekko for providing free access to their search API.