Ruby on rails 如何使用标记文件作为rdoc的主文件（在rails项目中）？

是否可以在Rails项目中使用readme.md文件，并让rdoc在主页上使用它？我尝试如下设置我的rake任务，但是生成的index.html页面有一个占位符语句。如果我更改为README.rdoc，它将按预期工作，包括文件的内容

我还尝试使用tomdoc，我想这可能会使事情变得复杂，不确定

RDoc::Task.new :rdoc do |rdoc|
  rdoc.main = "README.md"

  rdoc.rdoc_files.include("README.md", "doc/*.rdoc", "app/**/*.rb", "lib/**/*.rb", "config/**/*.rb")

  rdoc.title = "My Documentation"
  rdoc.options << "--all"
  rdoc.options << "--line-numbers"
  rdoc.markup = "tomdoc"
  rdoc.rdoc_dir = "rdoc"
end

RDoc:：Task.new:rdocdo | RDoc|
rdoc.main=“README.md”
rdoc.rdoc_文件。包括（“README.md”、“doc/*.rdoc”、“app/**.rb”、“lib/**.rb”、“config/**.rb”）
rdoc.title=“我的文档”
rdoc.options这并不是你问题的真正答案，但如果你想要一个好的选择：

使用场地

并使用以下提示：


我假设您希望使用README.md来兼容Github，我经常遇到同样的问题。
所以这是一个很好的选择。
个人分析我更喜欢YARD来记录我的ruby代码，它更强大，而且实际上与rubygems完全兼容，这是我更喜欢的方式

将其用于放大您的Rakefile：

require "github/markup"
require "redcarpet"
require "yard"
require "yard/rake/yardoc_task"

YARD::Rake::YardocTask.new do |t|
  OTHER_PATHS = %w()
  t.files = ['lib/**/*.rb', OTHER_PATHS]
  t.options = %w(--markup-provider=redcarpet --markup=markdown --main=README.md)
end

别忘了捆绑（更新您的Gemfile）
您是否尝试将rdoc.markup设置为“markdown”？只有
要求“yard”
在Rakefile中是必需的。