Possible formats and file names in GitHub main repository page, instead of README.md

github

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?

Best Answer

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.