How to open the doc file for a vim plugin

vimvim-plugins

I just downloaded the Rails vim plugin from here.

One of the file that it contain is a doc file that will be extracted to ~/.vim/doc/rails.txt

How do I open the content of this help file in vim ?

I tried :help rails to no avail.

Best Answer

After installing a new help file into ~/.vim/doc, you need to rebuild the help tags file:

:helptags ~/.vim/doc

Then your :help rails command should work.

Related Solutions

Vim doesn’t show plugin documentation

Vim needs to know when the help files are updated, so it can know where the NERDtree tag should point. Running the following in vim should fix it:

:helptags ~/.vim/doc

Vim: How tonstall Airline

Check the project's FAQ.

vim-airline doesn't appear until I create a new split

Add set laststatus=2 to your vimrc.

Inside vim, do :h laststatus to understand why this is needed. If you want to know in the future if a plugin is being "loaded" or not, check :scriptnames.

Best Answer

Related Solutions

Vim doesn’t show plugin documentation

Vim: How tonstall Airline

Related Question