search

openmod-initiative / toolchest

A common repository for tools used in energy modeling.
BSD 3-Clause "New" or "Revised" License
5 stars 4 forks source link

Github doesn't parse README.rst properly #4

Closed coroa closed 8 years ago

coroa commented 8 years ago

https://github.com/openmod-initiative/toolchest

looks broken.

ojdo commented 8 years ago

It should work though, if the rst is "fine". This README.rst renders fine, for example. This historic rst Issue on GitHub/markup hints that the converter might run into an error on our document (legitimately or not) and thus returns the source as a fallback.

That said, I'm very fine with markdown.

gidden commented 8 years ago

Yes, it may also be true that I mixed a bit of rst and md. I don't particularly care which one we go with.

On Tue, May 3, 2016 at 3:59 PM, Johannes Dorfner notifications@github.com wrote:

It should work though, if the rst is "fine". This README.rst https://github.com/jkbrzt/httpie/blob/master/README.rst renders fine, for example. This historic rst Issue on GitHub/markup https://github.com/github/markup/issues/265 hints that the converter might run into an error on our document (legitimately or not) and thus returns the source as a fallback.

That said, I'm very fine with markdown.

— You are receiving this because you are subscribed to this thread. Reply to this email directly or view it on GitHub https://github.com/openmod-initiative/toolchest/issues/4#issuecomment-216536407