Ruby和Ruby on Rails脱机API文档

在过去，我使用railsbrain.com有一个很好，方便的离线api文档。

但他们停止在版本2.3.2

有最新版本的其他解决scheme吗？

Answer 1

基于浏览器的解决scheme – 更新2017年10月19日

DevDocs （ https://devdocs.io/ ）使用浏览器的IndexedDB存储所需的文档。 请务必按照有关如何在脱机之前安装文档的说明。

---

对于macOS尝试短跑

对于Windows / Linux尝试Zeal

对于打包的HTML，请尝试RubyDocs

手册下载 ：

我在我的服务器上使用了这个命令，所以我可以更快地获得这些文件（它们被caching了，去图）。

wget -r -k -p http://api.rubyonrails.org/

• r – recursion
• k – 将链接转换为指向本地文件
• p – 获取所有图像，等需要显示的HTML页面

然后我压缩文件夹，所以我可以下载它没有开销。

rar a -r rails_api.rar api.rubyonrails.org/

• 一个 – 添加文件
• r – recursion

https://gist.github.com/2149669

YARD服务器

我更喜欢rdoc的码型。

1. 安装gem install yard ，
2. 重新生成所有的文档gem rdoc --all --overwrite和
3. 运行服务器的gemyard server --gems 。

Answer 2

railsapi.com 。 你可以构build和下载一个自定义的文档包的ruby版本1.9，导轨2.3.5和一些gem。

Answer 3

我意识到这个问题是相当古老的，但是由于Google在search“ruby on rails docs”时仍然很高，而且有几个人提出了railsapi.com，这个问题已经有将近一年的时间了。

所以我想提到http://rubydocs.org ，它具有与railsapi.com相同的function（包括Ruby和Rails的任何版本的组合文档）。

免责声明：我build立了http://rubydocs.org 。 🙂

Answer 4

在你的rails项目中：

API：

 rake doc:rails 

指南：

将RedCloth gem添加到您的Gemfile中

 gem 'RedCloth' 

然后

 rake doc:guides 

Answer 5

编辑（2016年2月）： http : //devdocs.io/看起来不错

只是没有提到，你也可以启动本地的gem rdoc服务器：

 $ gem server Starting gem server on http://localhost:8808/ localhost - - [13/Mar/2010:18:34:44 CET] "GET / HTTP/1.1" 200 22403 - -> / 

但它缺less关于Ruby核心库的信息。

Answer 6

我推荐bdoc 。 它是gem server的替代品，不需要运行服务器，看起来好多了。 只要做好gem install bdoc; bdoc gem install bdoc; bdoc或在这里查看更多细节。 你可以在这里findbdoc。

Answer 7

如果你在Mac上，我已经把Rails 3.0文档http://prii.it/blog/rails-3-dictionary-update放在一起。; 我还没有时间为Rails 3做这件事，但是一旦我有了这种心情，就会这样做。

其他Rails版本也可用。

Answer 8

那么http://railsapi.com/呢？;

Answer 9

我发现Aslam在这个话题上的post是对这个问题最有用，最容易实现的答案，它适用于当前版本的Rails API和Rails指南。 感谢Aslam把它放在一起。

基本上，你克隆当前的Rails的git回购计算机，然后运行

 bundle exec rake rdoc 

从rails目录中。

从那里，您可以将文档文件夹复制到计算机上的其他位置，并从浏览器本地运行。

Aslam的文章也向你展示了如何生成Rails指南的副本。

Answer 10

如果你在Windows上构build你自己的Ruby和Rails可search的API Doc post是生成它的好方法。

Answer 11

你可以使用apidocogem。 它简单易用。 有太多灵活的function了。

gem： https ： //rubygems.org/gems/apidoco/versions/0.1.0

文档： https ： //github.com/72pulses/apidoco

Answer 12

几年前，我曾经使用FXRI，这很酷： http ://rubyforge.org/projects/fxri/

虽然，我不知道它是否仍然有效，或者如果它与rvm很好。 我猜它已经被放弃了。 可惜，这是一个非常好的工具。

Answer 13

在查找离线文档时，我在Googlesearch中发现了这个问题。 它做了这项工作，但我发布了这个链接，目前包含（并使其更容易）所有的文档脱机使用的其他人谁发现自己在这里。 DOCS