From: Joel Pearson <lists@...>
Date: 2013-05-03T18:57:49+09:00
Subject: Linking Readme.md to a gem's documentation

I haven't been able to find a way to get Rubydoc to link my Readme.md
file into the documentation.
If I run YARD locally then it picks up the Readme file perfectly and
uses it.
However, Rubygems doesn't include it in the documentation online or in
the rdoc folder, even though Readme.md is included in the gem files.

Is there a way to add a Readme markdown file to the automatic
documentation generated on rubygems.org? At the moment I'm having to
link to Github for a Readme (and rubygems doesn't have a specific Readme
link), but YARD is clearly capable of doing this internally.

-- 
Posted via http://www.ruby-forum.com/.