如何使用markdown文件作爲rdoc的主文件（在rails項目中）？

是否可以在Rails項目中使用readme.md文件，並讓rdoc使用它作爲主頁面？我嘗試設置我的rake任務如下，但生成的index.html頁面有一個佔位符句子。如果我更改爲README.rdoc，它將按預期工作，包括文件的內容。如何使用markdown文件作爲rdoc的主文件（在rails項目中）？

我也試圖使用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

來源

2012-11-27 Adam Pope

你嘗試設置rdoc.markup爲 '降價'？ – mdesantis

這不是一個真正的回答你的問題，但如果你想有一個很好的選擇：

使用YARD

，並使用此技巧：

https://github.com/lsegal/yard/issues/404

我相信你想使用README.md來兼容Github，我經常遇到同樣的問題。所以這是一個很好的選擇。 Personnaly我優先YARD爲記錄我的紅寶石代碼，它更強大，實際上完全兼容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）

來源

2013-10-16 14:42:55 Romain

如何使用markdown文件作爲rdoc的主文件（在rails項目中）？

回答

相關問題