sponsor Vim development Vim logo Vim Book Ad

apidock.vim : Plugin that searches http://apidock.com Rails/Ruby/RSpec docs

 script karma  Rating -1/3, Downloaded by 802  Comments, bugs, improvements  Vim wiki

created by
Miles Sterrett
 
script type
utility
 
description
This plugin allows you to browse APIdock's Ruby, Rails, and RSpec docs from within Vim. It will invoke Firefox from the command line, and open the query in a new tab.

The plugin uses the command 'firefox', which it expects to be in your path, and executable from your shell. See 'Customization' below if you need some other behavior. (In particular, all of you OSX users will have to make a small change.) This should work out of the box on Ubuntu, and most other Linux-based systems on which Firefox is installed.

Usage

    *  RR - Search the Rails docs for the word under the cursor.
    *  RB - Search the Ruby docs for the word under the cursor.
    *  RS - Search the RSpec docs for the word under the cursor.

More info, as well as the unstable, development version is available here: http://github.com/mileszs/apidock.vim/tree/master
 
install details
Unpack the gzipped archive from within ~/.vim, and you should be good to go.

Otherwise, the file apidock.vim goes in ~/.vim/plugin, and the apidock.txt file belongs in ~/.vim/doc. Be sure to run

:helptags ~/.vim/doc

afterwards.
 

rate this script Life Changing Helpful Unfulfilling 
script versions (upload new version)

Click on the package to download.

package script version date Vim version user release notes
apidock.tar.gz 0.1 2009-03-05 6.0 Miles Sterrett Actual fix of the directory structure.
ip used for rating: 3.139.70.131

If you have questions or remarks about this site, visit the vimonline development pages. Please use this site responsibly.
Questions about Vim should go to the maillist. Help Bram help Uganda.
   
Vim at Github