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?

score 25 · Accepted Answer · answered Nov 11 '12 at 15:01

25

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.

answered Nov 11 '12 at 15:01

Sojan Jose · Answer 2 · 2018-02-27T17:30:23.227

7

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

edited Feb 27 '18 at 17:30

answered Jan 07 '15 at 08:03

Sojan Jose

3

Unfortunately, this website does not work anymore :'( – gillien Nov 27 '16 at 15:14
1

@JimEdelstein here is another project to preview rdoc/markdown/textile http://markup.herokuapp.com/sample – Chauskin Rodion Feb 27 '18 at 11:31
1

The currently linked website doesn't work any more either – Matthew Feb 04 '20 at 04:02

2 Answers2