Search code examples
githubrdoc

How to preview RDoc file?


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?


Solution

  • 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.