如何浏览本地项目文档

Question

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

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

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文件，在大多数现代Linux系统上都会sensible-browser。