2014-07-07 44 views
0

是否有任何Rails方式浏览在本地doc/文件夹中生成的文档,其命令rake doc:app如何浏览本地项目文档

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

回答

0

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系统上也将打开一个HTML文件sensible-browser

+1

够公平的。为了记录,我将'doc'文件夹符号链接到'/ var/www /'中,以便Apache知道它必须提供页面:'sudo ln -s〜/ www/yourownpoet/doc/var/www/yopdoc' –