Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Browse jQuery API doc quickly with Vim

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 autoload
Octocat-spinner-32 doc
Octocat-spinner-32 ftplugin
Octocat-spinner-32 plugin
Octocat-spinner-32 zip
Octocat-spinner-32 .gitignore
Octocat-spinner-32 README.markdown
Octocat-spinner-32 Rakefile
README.markdown

vim-jquery-doc is a little plugin that helps you to look up jQuery API doc website more quickly.

If you want something similar for Ruby/Rspec/Rails see vim-ruby-doc.

Installation

I strongly recommend installing pathogen.vim.

cd ~/.vim/bundle
git clone git://github.com/lucapette/vim-jquery-doc.git

Or you can unzip it in your ~/.vim directory.

How to use it

When your cursor is on a jQuery method, type JJ (or your own mapping, see settings for that) and the plugin will open a new tab in your browser (or a new instance of the browser) to the related docs. That's all.

Configure it

By default, the plugin uses the xdg-open command to look up the docs but you can easily change the command. For example, if you are on OSX you would like to change it to:

let g:jquery_doc_command='open'

Furthermore you can choose your own mapping in the following way:

let g:jquery_doc_mapping='KK'

Furthermore, the plugin defines the following command to search on the command-line:

  • JQueryDoc

Contributors

License

Copyright (c) Luca Pette. Distributed under the same terms as Vim itself. See :help license.

Something went wrong with that request. Please try again.