Mac 有人成功开启过 Dash 里面的 Ruby Gems 吗?

hpyhacking · 2014年01月09日 · 最后由 luikore 回复于 2014年01月09日 · 3812 次阅读

我已经把项目下 bundle exec gem env gempath 手工加入进去了(按照 rdoc 的方式生成了已经),Index 以后还是未能出现相关的文档。

连最基本的 bundler 的都出不来

我的 bundler 是有的,但也不是所有的 gems 都能查到

貌似 gem 目录下的 README 是不能被收录的

#3 楼 @hpyhacking 感觉 Dash 用来查 Ruby 和 Rails 的文档很不错,其他 gems 还是直接看 github 比较靠谱,或者用 pry 看代码也是个不错的选择

刚刚试了下, 可以的耶

#4 楼 @lululau 确实,但没网的情况下想看 Gem 的 Doc 很苦逼。

一直都是用 bundle show gem_name 得方式拿到 gem 安装路径,然后把 gem 得源码当文档看。

我觉得关键是很多 gem 写得好得人,很大一部分人注释文档写的不好,所以也不指望生产高质量得 RDoc 文档。

#7 楼 @lgn21st 这个方法好,本地配合一个 MD 阅读器就非常好用了。

Dash 不能识别 Rdoc 4.1.0 生成的 html rdoc 文件。 刚打开 Dash 能识别几个 Gem 的 Doc,看了下 Rdoc 4.1.0 和 Rdoc 3.x.x 生成的 html 文件开头标签有些不一样,可能 Dash 就识别不了。必须生成的是 HTML 格式的 doc, .ri 格式 Dash 肯定也不能识别。 试了试换了 rdoc 3.9.5 就能识别。 gem uninstall rdoc gem install rdoc -v '3.9.5'

gem rdoc --rdoc --all --overwrite 重新生成文档 要是旧版本的 rdoc 生成 doc 过程中有 encoding error 问题的话

export LANGUAGE=en_US.UTF-8
export LANG=en_US.UTF-8
export LC_ALL=en_US.UTF-8

写到.bashrc 或.zshrc 中,让 rdoc 默认使用 utf-8 就没问题了。

再打开 Dash 重新导入下 Ruby Installed Gems Docset,设置好要 index 的 gempath

不如直接用编辑器插件查 ri (rbenv shell system; rvm use system; sudo gem ins bcat)

#!/usr/bin/env ruby

require "shellwords"
word = ENV['TM_SELECTED_TEXT'] || ''
if word.empty?
  word = ENV['TM_CURRENT_WORD']
end

puts "<pre>"
system "ri -f ansi #{word.shellescape} | a2h"
puts "</pre>"

需要 登录 后方可回复, 如果你还没有账号请 注册新账号