Ruby和Ruby on Rails脱机API文档

Question

在过去,我使用railsbrain.com提供了一个非常方便的离线api文档.

但他们停在版本2.3.2

有没有最新版本的其他解决方案.

Answer 1

基于浏览器的解决方案 -  2017年10月19日更新

DevDocs(https://devdocs.io/)使用您的浏览器的IndexedDB来存储您想要的文档.确保在脱机之前按照有关如何安装文档的说明进行操作.

对于macOS,尝试Dash

对于Windows/Linux,请尝试Zeal

对于打包的HTML,请尝试使用RubyDocs

手动下载:

我在我的服务器上使用了这些命令,因此我可以更快地获取文件(它们被缓存,如图).

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

• r - 递归
• k - 将链接转换为指向本地文件
• p - 获取显示html页面所需的所有图像等

然后我压缩文件夹,以便我可以无需开销即可下载.

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

• a - 添加文件
• r - 递归

https://gist.github.com/2149669

YARD服务器

我比rdoc更喜欢码型.

1. 安装宝石gem install yard,
2. 重新生成所有文档gem rdoc --all --overwrite,并且
3. 运行gems的服务器yard server --gems.

Answer 2

railsapi.com.您可以构建和下载ruby版本的自定义文档包到1.9,rails到2.3.5和一些宝石.

Answer 3

我意识到这个问题已经相当陈旧了,但是因为在搜索"ruby on rails docs"时它仍然在谷歌中出现很高,而且有几个人建议使用已经停机近一年的railsapi.com.

所以我想提一下http://rubydocs.org,它具有与railsapi.com相同的功能和更多功能(使用你需要的任何版本生成Ruby和Rails的组合文档).

免责声明:我建立了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
- -> /

但它缺乏核心Ruby库的信息.