How to preview RDoc file?

Question

Want to see how an RDoc README file will look on Github before committing. How to run RDoc on a single file and preview the result in a browser?

Answer 1

Ruby as a built-in rdoc cli that will generate html pages from *.rdoc files:

rdoc README.rdoc -o ./tmp/doc

Try rdoc --help for more info.

Answer 2

As an alternative you can use this website to preview Markdown, RDoc, Textile ....