ruby-on-rails - 如何浏览本地项目文档

Question

是否有任何 Rails 方法可以doc/使用命令浏览本地文件夹中生成的文档rake doc:app？

我知道我可以将 Apache 配置为提供 doc 文件夹中的文件，但如果 R​​ails 也没有提供这样做的方法，我会感到惊讶。

Answer 1

Rails 不提供服务它的原因是因为它只是静态 HTML - 您可以直接在浏览器中打开它（例如。firefox doc/app/index.html），而不需要服务器。

如果您愿意，您可以为此添加自己的 Rake 任务lib/tasks/browserdoc.rake：

namespace :doc do
    desc "Browse application documentation"
    task :open do
        `firefox doc/app/index.html`
    end
end

某些系统具有与浏览器无关的快捷方式，您可以使用而不是硬编码浏览器名称；open在 Mac OSX 上，将在您当前的浏览器中打开一个 HTML 文件，就像sensible-browser在大多数现代 Linux 系统上一样。