从应用程序中呈现app / doc文件?

时间:2012-06-18 18:30:33

标签: ruby-on-rails ruby-on-rails-3

如何在父Rails应用程序(从中生成rdoc文件)的'app / doc'文件夹中呈现特定的rdoc文件(在本例中为Readme.rdoc)?我想渲染这个页面,以及rdoc .css文件,以便很好地格式化输出,但也保留在我的应用程序中。

2 个答案:

答案 0 :(得分:2)

这是一种方法:

生成新控制器(例如Rdocs)

rails g controller Rdocs index

在路线中添加

get "rdocs/index"
match "rdocs", :to => "rdocs#index"

您的控制器

def index
  render :text => File.open(Rails.root + "doc/README_FOR_APP", 'r').read       
end

或者如果你使用降价

def index
  m = Redcarpet::Markdown.new(Redcarpet::Render::HTML)
  content = m.render(File.open(Rails.root + "doc/README_FOR_APP", 'r').read)
  render :text => content
end

然后拨打/rdocs

答案 1 :(得分:0)

这是另一种选择:我想在/ about页面上显示README.rdoc。

在控制器中:

@readme = RDoc::Markup::ToHtml.new.convert(File.open(Rails.root.join('README.rdoc'), 'r').read)

在视图中:

<div class="readme">
  <h4>README.rdoc</h4>
  <div class="rdoc">
    <%= @readme.html_safe %>
  </div>
</div>