什么是在本地访问基于ruby的gem的文档的简单方法?

时间:2011-04-22 03:16:32

标签: ruby rubygems gem rdoc

我使用了一堆宝石,但我经常断开连接,希望能够在本地提取有关宝石的文档。

到目前为止,我唯一能做的就是去宝石库并找到自述文件。

有没有更好的方法可以在本地显示自述文件和完整文档而无需访问web / github?

6 个答案:

答案 0 :(得分:3)

你试过gem server吗?我没有安装RDocs,但我相信它将提供一种在离线状态下浏览RDoc的方法。

答案 1 :(得分:0)

gem server

还有一些角色。

答案 2 :(得分:0)

gem server

这将启动您可以浏览的local web server。如果gem包含文档,那么就可以获得它。

答案 3 :(得分:0)

我有以下简单的shell脚本,允许我在离线和我的提示下浏览所有内容:

> cat ~/bin/rim
ri -Tf ansi -w 150 $1

使用

> rim Bundler

Bundler

(from gem bundler-1.0.10)
------------------------------------------------------------------------------
Constants:

[...]

答案 4 :(得分:0)

如果您不喜欢

,这里还有很多其他工具
gem server

http://ruby-toolbox.com/categories/gem_doc_viewers.html

答案 5 :(得分:0)

参考。 http://guides.rubygems.org/rubygems-basics/#viewing-documentation

您可以使用ri [options] [names]命令,例如ri RBTreeri --help了解更多信息。

gem server命令,您可以在localhost:8808

访问文档