Sunday, February 22, 2009

Formatting README.rdoc on github

Github has a neat feature that displays a README file, that it finds in the root directory of a project, on the project page. The README formatting page describes a number of different formats that it will render based on the file extension. I tried renaming to README.rdoc but it still rendered as plain text. The trouble was that the file was intended to be used with a full RDOC site for the source. When I removed the "link" tags from the file and pushed ... Github renders it correctly ... Hurrah!

2 comments:

Matt Brennan said...

The following code rendered for me ok:

{demo app}[http://github.com/neworganizing/rails_vip_demo]

Bryan Ash said...

Matt, my problem links were of the form:

{Operations}[link:classes/Nobbie/Wx/Operations.html]

that is, they were RDoc relative links to generated pages that don't exist in Github.

Post a Comment