Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How to preview RDoc file?

Tags:

github

rdoc

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?

like image 700
B Seven Avatar asked Nov 11 '12 14:11

B Seven


2 Answers

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.

like image 163
Jean-Louis Giordano Avatar answered Nov 11 '22 15:11

Jean-Louis Giordano


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

like image 7
Sojan Jose Avatar answered Nov 11 '22 14:11

Sojan Jose