How to preview RDoc file?

Asked 11/11, 2012 at 14:7 Answered 7/1, 2015 at 8:3

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?

Dinse answered 11/11, 2012 at 14:7 Comment(0)

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.

Ilona answered 11/11, 2012 at 15:1 Comment(0)

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

Swinish answered 7/1, 2015 at 8:3 Comment(3)

Unfortunately, this website does not work anymore :'( – Adeline 27/11, 2016 at 15:14

@JimEdelstein here is another project to preview rdoc/markdown/textile markup.herokuapp.com/sample – Switchman 27/2, 2018 at 11:31

The currently linked website doesn't work any more either – Johnnyjohnnycake 4/2, 2020 at 4:2