Làm cách nào để sử dụng tệp đánh dấu làm tệp chính cho rdoc (trong dự án đường ray)?

Question

Có thể sử dụng tệp readme.md với dự án Rails và có sử dụng nó một trang chính không? Tôi đã thử thiết lập nhiệm vụ rake của tôi như sau, nhưng trang index.html được tạo ra có một câu giữ chỗ. Nếu tôi thay đổi thành README.rdoc, nó hoạt động như mong đợi bao gồm nội dung của tệp.

Tôi cũng đang cố gắng sử dụng tomdoc mà tôi đoán có thể là vấn đề phức tạp, không chắc chắn.

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

Nó không thực sự là một câu trả lời cho vấn đề của bạn, nhưng nếu bạn muốn có một lựa chọn tốt:

sử dụng YARD

và sử dụng lời khuyên này:

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

Tôi đoán bạn muốn sử dụng README.md để được Github tuân thủ, tôi thường có cùng một vấn đề. vì vậy đây là một lựa chọn tốt. Personnaly tôi prefere YARD cho tài liệu mã ruby ​​của tôi, nó mạnh mẽ hơn, và thực sự hoàn toàn tương thích với rubygems, đó là cách ưa thích.

Cho rằng để phóng to Rakefile của bạn:

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 

Đừng quên bó (cập nhật Gemfile của bạn)