Как быстро получить доступ к документации по ruby ​​и rails при использовании vim?

Question

Какой способ используют пользователи vim для быстрого доступа к документации как для ruby, так и для rails (кроме переключения на браузер для использования ruby-doc или railsapi ?).

Я пытался адаптировать этот скрипт (http://vim.wikia.com/wiki/Online_documentation_for_word_under_cursor), чтобы добиться цели, однако он будет работать только в том случае, если курсор находится над именем класса, и я бы хотел, чтобы он работал как с классом, так и с методами.

Спасибо.

Answer 1

Похоже, что вы, возможно, ответили на это сами с помощью этой функции, но есть несколько существующих плагинов Vim, которые могут получить доступ к ri на лету в Vim. Я использую PA_ruby_ri . Вы также можете попробовать ri-browser и ruby-menu , хотя я не могу лично поручиться за них.

Answer 2

Это старый пост, но для будущих гуглеров я бы предложил 2 плагина:

1. ri.vim : для вывода в автономном режиме ri документов в Vim.
2. vim-ruby-doc : открыть онлайн rdoc.info , api.rubyonrails.org или rspec relishдокументы в браузере.

Кстати, если вы ищете документацию по CSS, DOM, HTML, JavaScript, JQuery или PHP, посмотрите мой плагин lil dochub.vim .

Answer 3

Удалось изменить скрипт в OP для работы с сликом http://railsapi.com (который также предоставляет документы для ruby, rspec и др.)использование лидера + 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, не используйте это, ха.

Answer 4

Установите шпаргалку драгоценный камень и просто раскройте его, чтобы получить доступ к быстрому тексту помощи.

:! cheat cheat

Роб Конери на Tekpub.com использует этот драгоценный камень в своих видеороликах, и он весьма полезен.

Answer 5

Если вы на Mac, попробуйте dash.vim . Работает для Rails и множества других фреймворков и языков .

Answer 6

Я обычно использую браузер для чтения онлайн-документов из-за гиперссылок.Это облегчает переход между связанными страницами.

В противном случае, я буду держать окно терминала открытым, для страниц ri и man.

Также внутри vimЯ открою отдельную вкладку и буду использовать ее для просмотра документов.Это работает очень хорошо, потому что мне не нужно перетасовывать сплит.

Последние два - старая школа, но они работают хорошо.