vim-ruby-doc is a little plugin that helps you to look up documentation using the following resources:
If you want something similar for jQuery API documentation see vim-jquery-doc.
I strongly recommend installing pathogen.vim.
cd ~/.vim/bundle git clone git://github.com/lucapette/vim-ruby-doc.git
Or you can unzip it in your
How to use it
In Normal mode, when your cursor is on something you would look up type:
and the plugin will open a new tab in your browser (or a new instance of the browser) to the related docs. See the following section for changing mappings.
Furthermore, the plugin defines the following commands for searching on the command-line arbitrary stuff:
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:
Furthermore you can choose your own mapping in the following way:
You can change where the plugin should search very easily:
Include /doc/tags in .gitignore.
Move away from apidock.
Add configurable search host.
Moving mappings to filetype directory
Copyright (c) Luca Pette. Distributed under the same terms as Vim itself. See