¿Cómo se puede acceder rápidamente a la documentación de ruby ​​y rieles cuando se usa vim?

Question

¿Qué método usan los usuarios de vim para acceder rápidamente a la documentación de ruby ​​y rieles (además de cambiar al navegador para usar ruby-doc o railsapi?).

Estaba tratando de adaptar este script (http://vim.wikia.com/wiki/Online_documentation_for_word_under_cursor) para hacer el truco, sin embargo, solo funcionará si el cursor está sobre el nombre de una clase y me gustaría que funcione tanto con clase como con métodos.

Gracias.

Answer 1

Parece que puede haber respondido esto usted mismo con esa función, pero hay un par de complementos Vim existentes que pueden acceder a ri sobre la marcha dentro de Vim. Yo uso PA_ruby_ri. También puede probar ri-browser y ruby-menu, aunque personalmente no puedo responder por ninguno de ellos.

Answer 2

Instale la gema cheat sheets y simplemente descuelgue para acceder a un texto de ayuda rápida.

:! cheat cheat 

Rob Conery en Tekpub.com utiliza esta gema en sus videos de rieles y es bastante útil.

Answer 3

Gestionado para modificar la secuencia de comandos en el OP para trabajar con la mancha http://railsapi.com (que también proporciona documentos para ruby, rspec y más).

Añadido el siguiente a mi .vimrc, a continuación, utilizando el líder + d se carga hasta la documentación para la palabra el cursor está en:

" 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, por favor no utilice este, ja.

Answer 4

Normalmente utilizo un navegador para leer documentos en línea, debido a la hipervinculación. Hace que sea mucho más fácil saltar entre las páginas relacionadas.

De lo contrario, voy a mantener una ventana de terminal abierta, para ri y man páginas.

Además, dentro de vim, abriré una pestaña separada y la usaré para ver los documentos. Eso funciona bastante bien porque no tengo que barajar divisiones.

Las dos últimas son de la vieja escuela, pero funcionan bien.

Answer 5

Esta es una entrada antigua, pero para los futuros empleados de Google, sugeriría 2 plugins:

1. ri.vim: para que aparezca en línea ri documentos dentro de Vim.
2. vim-ruby-doc: para abrir en línea rdoc.info, api.rubyonrails.org, o rspec relish docs en un navegador.

BTW Si está buscando documentación de CSS, DOM, HTML, JavaScript, JQuery o PHP, consulte mi plugin de lil dochub.vim.

Answer 6

Si está en una Mac, intente dash.vim. Works for Rails y lots of other frameworks and languages también.