Web Applications Stack Exchange is a question and answer site for power users of web applications. It only takes a minute to sign up.
Sign up to join this community
In GitHub, a repository's main page, under the list of files, by default, there's a compiled view of a README.md markdown file.
I like it. But, can this be a reStructuredText file, or an HTML file, instead?
What's the support? What is the logic there? What can I use?
A Github readme needs to be called readme to be picked up. GitHub supports the extensions listed below, you can read more details on the markdown readme file.
The following are my findings so far.
I'm also waiting for an answer from GitHub.
John C's, answer regarding the formats leads us to the GitHub markup library, which answers the formats question.
It seems that the name, excluding the extension, must be README.
Seems to be case–insensitive.
Case of the extension does seem to matter.
