github - 如何预览RDoc文件？

Question

想要在提交之前查看RDoc README文件在Github上的外观。如何在单个文件上运行RDoc并在浏览器中预览结果？

Answer 1

Ruby作为内置的rdoc cli，它将从*.rdoc文件生成html页面:

rdoc README.rdoc -o ./tmp/doc

尝试rdoc --help获取更多信息。