过去我使用railsbrain.com来获取一个很好且方便的离线api文档。
但是他们停在版本2.3.2。
是否有其他解决方案可以获得最新版本的文档。
过去我使用railsbrain.com来获取一个很好且方便的离线api文档。
但是他们停在版本2.3.2。
是否有其他解决方案可以获得最新版本的文档。
基于浏览器的解决方案 - 2017年10月19日更新
DevDocs(https://devdocs.io/)使用您的浏览器 IndexedDB 存储所需的文档。请确保在离线之前按照说明安装文档。
对于macOS,请尝试Dash
对于Windows / Linux,请尝试Zeal
对于打包的 HTML,请尝试RubyDocs
手动下载:
我在服务器上使用以下命令,以便更快地获取文件(它们已被缓存,想一想就知道)。
wget -r -k -p http://api.rubyonrails.org/
然后我压缩文件夹,这样我就可以下载它而不会有额外的开销。
rar a -r rails_api.rar api.rubyonrails.org/
https://gist.github.com/2149669
YARD 服务器
我更喜欢 yard 格式而不是 rdoc。
gem install yard
,gem rdoc --all --overwrite
,并且yard server --gems
。railsapi.com。你可以构建并下载与Ruby版本至1.9、Rails版本至2.3.5以及一些gem相关的自定义文档包。
我意识到这个问题已经相当老了,但由于在搜索 "ruby on rails docs" 时仍然在谷歌上排名较高,并且有几个人建议使用 railsapi.com,但该网站已经停止运营近一年。
所以我想提到 http://rubydocs.org,它具有与railsapi.com相同的功能,而且更多(生成任何你需要版本的Ruby和Rails的综合文档)。
免责声明:我建立了http://rubydocs.org。:)
rake doc:rails
指南:
在Gemfile文件中添加RedCloth gem。
gem 'RedCloth'
那么
rake doc:guides
编辑(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库的信息。
bundle exec rake rdoc
从Rails目录中开始。
然后,您可以将文档文件夹复制到计算机上的其他位置,并从浏览器本地运行。
Aslam的帖子还向您展示了如何生成Rails指南的副本。
gem rdoc --rdoc --all
- PhilT