What file types does GitHub support for README's

Question

I have noticed that many different file types are used for GitHub READMEs. The most common ones are .md and .rst

After looking at the GitHub documentation and the help page I found no information on which file types are allowed.

I am just looking for a list of the types so I can figure out which types I can use for my next README.

@HaydenThring Yes, the Markdown renderer appears to be quite flexible, but I don't believe that mixing HTML in with Markdown is recommended as per the 'Markdown Style Guide' if there is such a thing. — William V., Oct 07 '20 at 02:52
I was a bit quick to post, as while it will display it, i cant seem to get it to interpret the html codes. — Hayden Thring, Oct 10 '20 at 22:39

score 21 · Accepted Answer · edited Jul 05 '23 at 02:42

21

GitHub uses its own Markup library to render files like READMEs. It supports:

edited Jul 05 '23 at 02:42

TAbdiukov

answered Dec 13 '16 at 01:26

mipadi

Those are each variations of Markup? – William V. Dec 13 '16 at 01:35
2

I am asking more of what file types such a .txt, .md, etc. – William V. Dec 13 '16 at 01:54
8

@WilliamV: If you follow the [Markup library](https://github.com/github/markup/blob/master/README.md#markups) link in the answer, it shows the file extensions and links to more information about each format. – Keith Thompson Dec 13 '16 at 03:32

1 Answers1