मैं मार्कॉक फ़ाइल को rdoc (रेल परियोजना में) के लिए मुख्य फ़ाइल के रूप में कैसे उपयोग करूं?

Question

क्या रेलवे प्रोजेक्ट के साथ readme.md फ़ाइल का उपयोग करना संभव है और क्या rdoc इसे मुख्य पृष्ठ का उपयोग कर रहा है? मैंने अपने रेक कार्य को निम्नानुसार स्थापित करने का प्रयास किया, लेकिन जेनरेट होने वाले index.html पृष्ठ में प्लेसहोल्डर वाक्य है। यदि मैं README.rdoc में बदलता हूं तो यह अपेक्षित कार्य करता है जैसे फाइल की सामग्री शामिल है।

मैं टॉमडोक का उपयोग करने की भी कोशिश कर रहा हूं जो मुझे लगता है कि जटिल हो सकता है, निश्चित नहीं है।

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

यह वास्तव में आपकी समस्या का उत्तर नहीं है, लेकिन अगर आप एक अच्छा विकल्प हैं:

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

मुझे लगता है:

उपयोग यार्ड

और इस युक्तियों का उपयोग आप Github अनुपालन के लिए README.md का उपयोग करना चाहते हैं, मुझे अक्सर एक ही समस्या है। तो यह एक अच्छा विकल्प है। व्यक्तिगत रूप से मैं अपने रूबी कोड को दस्तावेज करने के लिए यार्ड को पसंद करता हूं, यह अधिक शक्तिशाली है, और वास्तव में रूबीगेम्स के साथ पूरी तरह से संगत है, यह पसंदीदा तरीका है।

दें कि आपके 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 अद्यतन)