Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

What file types does GitHub support for README's

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.

like image 941
William V. Avatar asked Dec 13 '16 00:12

William V.


1 Answers

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

  • Markdown
  • Textile
  • RDoc
  • Org
  • Creole
  • MediaWiki
  • Restructured Text
  • AsciiDoc
  • Perl Pod
like image 56
mipadi Avatar answered Nov 16 '22 04:11

mipadi