Ruby和Ruby on Rails脱机API文档

时间:2010-03-13 17:04:28

标签: ruby-on-rails ruby api documentation

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

但他们停在版本2.3.2

是否有其他最新版本的解决方案。

13 个答案:

答案 0 :(得分:59)

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

DevDocshttps://devdocs.io/)使用浏览器的IndexedDB存储所需的文档。确保在脱机之前按照说明如何安装文档。


对于 macOS ,请尝试Dash

对于 Windows / Linux ,请尝试Zeal

对于打包的HTML ,请尝试RubyDocs

手动下载

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

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

  • r - recursive
  • k - 将链接转换为指向本地文件
  • p - 全部搞定 显示html页面所需的图像等

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

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

  • a - 添加文件
  • r - recursive

https://gist.github.com/2149669

YARD服务器

我比rdoc更喜欢码型。

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

答案 1 :(得分:24)

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

答案 2 :(得分:14)

我意识到这个问题还很老,但是因为在搜索“ruby on rails docs”时谷歌仍然很高,而且有几个人建议使用已经停机近一年的railsapi.com。

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

免责声明:我制作了http://rubydocs.org。 :)

答案 3 :(得分:8)

在您的rails项目中:

<强> API:

rake doc:rails

<强>指南:

将RedCloth gem添加到您的Gemfile

gem 'RedCloth'

然后

rake doc:guides

答案 4 :(得分: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库的信息。

答案 5 :(得分:4)

我推荐bdoc。它是gem server的替代品,不需要让服务器运行并且看起来更好。只需gem install bdoc; bdoc或查看更多详细信息。你可以找到bdoc here

答案 6 :(得分:3)

如果您使用的是Mac,我会使用Rails 3.0文档http://prii.it/blog/rails-3-dictionary-update整理一本字典。我没有时间为Rails 3做这件事,但是一旦我有心情就会这样做。

其他Rails版本也可用。

答案 7 :(得分:3)

我发现Aslam's post on this topic是对这个问题最有用,易于实现的答案,它适用于当前版本的Rails API和Rails指南。感谢Aslam把它放在一起。

基本上,您将当前的Rails git repo克隆到您的计算机,然后运行

bundle exec rake rdoc

来自rails目录。

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

Aslam的帖子还向您展示了如何生成Rails指南的副本。

答案 8 :(得分:2)

http://railsapi.com/怎么办?

答案 9 :(得分:2)

如果您使用的是Windows Build your own Ruby and Rails Searchable API Doc帖子,则可以很好地生成帖子。

答案 10 :(得分:1)

您可以使用apidoco gem。它简单易用。也有这么多灵活的功能。

宝石:https://rubygems.org/gems/apidoco/versions/0.1.0

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

答案 11 :(得分:0)

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

虽然,我不知道它是否仍然有用,或者它是否与rvm相配。我猜它已被抛弃了。 遗憾的是,这是一个非常好的工具。

答案 12 :(得分:0)

我在寻找离线文档时在Google搜索中发现了这个问题。它完成了这项工作,但是我发布了这个链接,该链接目前包含(并且更容易)所有发现自己在这里的人的离线使用文档。 DOCS