Jak używać pliku przeceny jako głównego pliku dla rdoc (w projekcie szyn)?

Question

Czy można użyć pliku readme.md z projektem Rails i czy rdoc używa go jako strony głównej? Próbowałem skonfigurować moje zadanie rake w następujący sposób, ale strona index.html, która jest generowana, ma zdanie zastępcze. Jeśli zmienię na README.rdoc, działa zgodnie z oczekiwaniami, ponieważ zawiera zawartość pliku.

Próbuję również użyć tomdoc, co chyba może być skomplikowane, nie jestem pewien.

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 

Answer 1

To naprawdę nie jest odpowiedź na Twój problem, ale jeśli chcesz dobrą alternatywę:

użycia stoczni

i wykorzystać te wskazówki:

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

Przypuszczam chcesz, aby README.md był zgodny z Github, często mam ten sam problem. , więc jest to dobra alternatywa. Personality i preferuję YARD do dokumentowania mojego kodu ruby, jest bardziej wydajny, a właściwie całkowicie kompatybilny z rubygmami, jest to preferowany sposób.

Daj zdjęcie, aby powiększyć swoją 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 

Nie zapomnij Bundle (zaktualizować Gemfile)