ruby - 在本地访问 ruby​​ 标准库文档

Question

我刚开始接触 Ruby - 我遇到一些麻烦的事情是 Intellisense / 代码完成，所以如果我没有，我真的需要随时让 API 近在咫尺。我上周发现：

gem server

它会启动一个服务器，让您可以查看所有已安装 gem 的文档。是否有与此等价的工具可以让您浏览标准库而不是 gem？

使用 Linux/Ruby 1.8.7。

Answer 1

在您的终端中，您可以使用ri打印文档的特定部分。（请注意，如果您使用 RVM 来管理您的 ruby​​ 安装，您可能需要运行rvm docs generate以避免收到“Nothing known about....”响应）

例如：

> ri Array#drop

会输出：

------------------------------------------------------------- Array#drop
     ary.drop(n)               => array
------------------------------------------------------------------------
     Drops first n elements from _ary_, and returns rest elements in an
     array.

        a = [1, 2, 3, 4, 5, 0]
        a.drop(3)             # => [4, 5, 0]

Answer 2

几个选项：

• 本地、可搜索的 Rails 和 Ruby 文档（添加其他文档的选项，如 haml、rspec、rack 等，但不是最新的）
• 从源创建
• 里
• ... 以及一百万个从 Ruby 源代码生成时髦文档的工具，包括...
• doc，它生成您告诉它的任何内容的本地可搜索文档；我在挖

Answer 3

Devdocs完成了这项工作

• 它（也）离线工作
• 它不仅限于 ruby​​ 文档 ;)

从 github 克隆 repo：

git clone git@github.com:Thibaut/devdocs.git
cd devdocs

安装依赖项：

gem install bundler
bundle install

下载文档：

thor docs:download --all

运行：

rackup

默认情况下可以在http://localhost:9292