Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Viewing .rst within a "github pages" site

I'm moving an open source project's documentation over to Github Pages but I'm stuck on moving the .rst files.

We have a ReadMe.rst which you can see here in the code. I'd like to link to that page from our main documentation page but GitHub doesn't render the .rst as HTML so the browser simply downloads the text of the .rst file when you click the link).

There are of course tools to render .rst as HTML but that's a serious extra step. The whole reason we started using .rst was entirely because GitHub renders it automatically in code pages. You'd think there'd be some way to get this authomatic rendering happening for Github Pages...

like image 955
Tom Swirly Avatar asked Feb 25 '13 19:02

Tom Swirly


1 Answers

GitHub Pages does not have support for .rst/RestructuredText. It only supports Markdown and Textile conversion to HTML.

like image 88
parkr Avatar answered Oct 02 '22 05:10

parkr