如何浏览本地项目文档

Question

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

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

Answer 1

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

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

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

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