使用vim时如何快速访问ruby和rails文档?

时间:2011-01-15 01:16:53

标签: ruby-on-rails ruby vim

vim用户使用哪种方法快速访问ruby和rails的文档(除了切换到浏览器以使用ruby-docrailsapi?)。

我试图调整这个脚本(http://vim.wikia.com/wiki/Online_documentation_for_word_under_cursor)来完成这个技巧,但是只有当光标位于类名上并且我希望它能同时使用类和方法时它才会起作用。 / p>

感谢。

6 个答案:

答案 0 :(得分:3)

似乎您可能已经使用该功能自行解决了这个问题,但是有一些现有的Vim插件可以在Vim中即时访问ri。我使用PA_ruby_ri。您也可以尝试ri-browserruby-menu,但我不能亲自担保其中任何一个。

答案 1 :(得分:2)

管理修改OP中的脚本以使用光滑的http://railsapi.com(它还提供了ruby,rspec等文档)。

在我的.vimrc中添加了以下内容,然后使用leader + d将加载光标所在单词的文档:

" online documentation search
function! OnlineDoc()
  if &ft =~ "ruby"
    let s:urlTemplate = "http://railsapi.com/doc/rails-v2.3.8_ruby-v1.8/?q=%"
  else
    return
  endif
  let s:wordUnderCursor = expand("<cword>")
  let s:url = substitute(s:urlTemplate, "%", s:wordUnderCursor, "g")
  let s:cmd = "!open \"" . s:url . "\""
  execute s:cmd
endfunction

map <silent> <leader>d :call OnlineDoc()<CR>

coreyward,请不要使用它,哈。

答案 2 :(得分:2)

这是一篇旧帖子,但对于未来的googlers,我建议使用2个插件:

  1. ri.vim:在Vim中调出离线ri文档。
  2. vim-ruby-doc:在浏览器中显示在线rdoc.infoapi.rubyonrails.orgrspec relish docs
  3. BTW如果您正在寻找CSS,DOM,HTML,JavaScript,JQuery或PHP文档,请查看我的lil插件dochub.vim

答案 3 :(得分:1)

安装cheat sheets gem并简单地弹出以访问快速帮助文本。

:! cheat cheat

在Tekpub.com上的Rob Conery在他的铁轨视频中使用了这个宝石,它非常有用。

答案 4 :(得分:0)

由于超链接,我通常使用浏览器来阅读在线文档。它使得在相关页面之间跳转变得容易得多。

否则,我会为riman页面打开一个终端窗口。

此外,在vim中,我将打开一个单独的选项卡,并使用它来查看文档。这非常有效,因为我不需要改组分裂。

最后两个是老派,但效果很好。

答案 5 :(得分:0)

如果您使用的是Mac,请尝试dash.vim。适用于Rails和lots of other frameworks and languages