ruby - 我可以使用正确的格式将README.textile放入RDoc吗？

我喜欢使用Textile或Markdown为我的项目编写自述文件，但是当我生成RDoc时，自述文件被解释为RDoc，看起来确实很恐怖。有没有一种方法可以使RDoc通过RedCloth或BlueCloth而不是其自己的格式化程序来运行文件？可以将其配置为从文件后缀自动检测格式吗？ (例如README.textile通过RedCloth运行，而README.mdown通过BlueCloth运行)

最佳答案

如果文件后缀合理，则直接使用YARD而不是RDoc将允许您包含Textile或Markdown文件。我经常使用以下Rake任务:

desc "Generate RDoc"
task :doc => ['doc:generate']

namespace :doc do
  project_root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
  doc_destination = File.join(project_root, 'doc', 'rdoc')

  begin
    require 'yard'
    require 'yard/rake/yardoc_task'

    YARD::Rake::YardocTask.new(:generate) do |yt|
      yt.files   = Dir.glob(File.join(project_root, 'lib', '**', '*.rb')) +
                   [ File.join(project_root, 'README.md') ]
      yt.options = ['--output-dir', doc_destination, '--readme', 'README.md']
    end
  rescue LoadError
    desc "Generate YARD Documentation"
    task :generate do
      abort "Please install the YARD gem to generate rdoc."
    end
  end

  desc "Remove generated documenation"
  task :clean do
    rm_r doc_dir if File.exists?(doc_destination)
  end

end

关于ruby - 我可以使用正确的格式将README.textile放入RDoc吗？，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/2138427/