Investigate.vim : A plugin for viewing documentation
| script karma
Downloaded by 196
Comments, bugs, improvements
script versions (upload new version)
The plugin is on Github https://github.com/Keithbsmiley/investigate.vim/
A plugin for looking documentation on the word under the cursor.
You can choose to open it in a browser, with
[Dash](http://kapeli.com/dash) on OS X, or with an arbitary
nnoremap K :call investigate#Investigate()<cr>
With this mapping, using capital K when your cursor is on a specific
word will open its documentation. The [help
has tons of documentation on configuration. Here are some of the
If you want to open everything in Dash you need to set:
This value is ignored unless you're on OS X. If you want to use Dash
conditionally based off the current filetype you can set something like:
If you want to use something else, like a URL for a single type you'd
want to use this which will override the global Dash setting:
If you use a different keyword in Dash for a given language you can
set it by using:
This would set all Ruby files to open in the Rails documentation.
If you don't like the website I chose as the default for a filetype you
can redefine it with:
Where `^s` will be replaced with the word under the cursor for Ruby
### Custom Commands
You can also open documentation with arbitrary shell commands. See
`investigate-writing-commands` in the documentation for more info.
### Project specific settings
You can setup project specific settings with an `.invrc` file from the
directory you launch Vim in. For example for a Rails project you may
want to set Ruby files to open Rails documentation for that single
project but not other Ruby gem based projects you're working on. To do
that the file would look something like this:
This will set a syntax variable:
Which entirely changes Ruby files to open in the Rails documentation.
See `investigate-conf-file` for more information.
### With [Vundle](https://github.com/gmarik/vundle)
To your `.vimrc` and run `BundleInstall` from within vim or `vim +BundleInstall +qall` from the command line
### With [Pathogen](https://github.com/tpope/vim-pathogen)
git clone https://github.com/Keithbsmiley/investigate.vim.git
To generate the helptags afterwards run `:Helptags`
If you find any bugs, want any languages added, or want any default
language settings changed, please submit an
Click on the package to download.
ip used for rating: 22.214.171.124