Browse Ruby RSpec and Rails API docs quickly with Vim
Vim script Ruby
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
autoload
doc
ftplugin
plugin
zip
.gitignore
README.markdown
Rakefile

README.markdown

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.

Installation

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 ~/.vim directory.

How to use it

In Normal mode, when your cursor is on something you would look up type:

  • RB for Ruby
  • RS for RSpec
  • RR for Rails

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:

  • :RubyDoc
  • :RspecDoc
  • :RailsDoc

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:

let g:ruby_doc_command='open'

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

let g:ruby_doc_ruby_mapping='KK'

There are g:ruby_doc_rspec_mapping and g:ruby_doc_rails_mapping variables too.

You can change where the plugin should search very easily:

let g:ruby_doc_ruby_host='http://apidock.com/ruby/'

Contributors

License

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