How to view the RDoc file?

Question

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

Answer 1

Ruby as an embedded rdoc cli that will generate html pages from *.rdoc files:

 rdoc README.rdoc -o ./tmp/doc 

Try rdoc --help for more information.

Answer 2

Alternatively, you can use this website to preview Markdown, RDoc, Textile ....

Answer 3

Great tool to preview rdoc on the web.

http://markup.herokuapp.com/sample

Many thanks to the creators of such a wonderful tool.