logo标签列表

Ruby和Ruby on Rails离线API文档

ruby-on-railsrubyapidocumentation
42

过去我使用railsbrain.com来获取一个很好且方便的离线api文档。

但是他们停在版本2.3.2。

是否有其他解决方案可以获得最新版本的文档。

13个回答
64

基于浏览器的解决方案 - 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 服务器

我更喜欢 yard 格式而不是 rdoc。

  1. 安装 gem gem install yard,
  2. 重新生成所有文档 gem rdoc --all --overwrite，并且
  • 运行服务器以获取宝石 yard server --gems。
    • 1
    +1 for Dash 参考。我以前从未听说过它。我想我会喜欢它的！！ - Meltemi
    谢谢分享Dash的链接。到目前为止，我很喜欢它！ - GregT
    1
    对于Rubygems的较新版本：gem rdoc --rdoc --all - PhilT
    24

    railsapi.com。你可以构建并下载与Ruby版本至1.9、Rails版本至2.3.5以及一些gem相关的自定义文档包。

    5
    当你尝试下载时出现“未找到”的提示 :( 好烦啊。 - Damien Roche
    16

    我意识到这个问题已经相当老了，但由于在搜索 "ruby on rails docs" 时仍然在谷歌上排名较高，并且有几个人建议使用 railsapi.com，但该网站已经停止运营近一年。

    所以我想提到 http://rubydocs.org，它具有与railsapi.com相同的功能，而且更多（生成任何你需要版本的Ruby和Rails的综合文档）。

    免责声明：我建立了http://rubydocs.org。:)

    为什么我必须等待文档准备好呢？你不能创建所有可能的组合并将它们存储在服务器上吗？ - CamelBlues
    1
    RubyDocs目前跟踪281个Ruby版本和213个Rails版本。所有可能的组合接近于60,000。虽然完全可以生成和存储所有这些版本，但这将是浪费时间和空间，因为只有少数版本真正有用。 - Manuel Meurer
    很好，非常有帮助。但是，如果我需要yardoc，我该怎么办？ - Anwar
    1
    太棒了！谢谢！！ - jpgeek
    9
    在你的Rails项目中：
    API：
    rake doc:rails

    指南：

    在Gemfile文件中添加RedCloth gem。

    gem 'RedCloth'

    那么

    rake doc:guides
    好的回答。但是，如果我想使用yardoc而不是rdoc来进行API文档编写，我需要做什么？ - Anwar
    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库的信息。

    +1 用于 gem 服务器。关于缺失的核心库信息，我认为 rdoc-data gem 可以帮助解决。 - the Tin Man
    DevDocs！哇！你一直在我生命中的哪里？ - Jay Killeen
    4

    我推荐使用bdoc。它是gem server的替代品，无需运行服务器，并且看起来更美观。只需执行gem install bdoc; bdoc或查看更多详细信息此处。

    3
    如果您使用的是Mac系统，我已经为Rails 3.0文档制作了一个词典。http://prii.it/blog/rails-3-dictionary-update。其他版本的Rails也可用。我目前没有时间为Rails 3做更新，但一旦有心情，我会尽快完成。请注意保留HTML标记。
    3
    我发现Aslam关于这个话题的帖子是最有用、易于实施的答案，而且适用于当前版本的Rails API和Rails Guides。感谢Aslam的整理。
    基本上，你需要将当前的Rails git repo克隆到你的电脑上，然后运行：
    bundle exec rake rdoc

    从Rails目录中开始。

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

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

    2
    2
    网页内容由stack overflow 提供, 点击上面的
    可以查看英文原文，
    原文链接