github の README ファイルの優先順位

github には

• リポジトリに「README」ファイルがあれば、その内容がリポジトリの先頭ページに表示される
• https://github.com/github/markup に挙がっている拡張子を付加すれば、そのマークアップとみなしてレンダリングされる

という機能があるわけですが、複数のマークアップがある場合にどれが優先されるのか調べてみました。

実験方法

以下のファイルをリポジトリに放りこんで、どれが表示されるか確認する→表示されたものから順に消していく、という方法で調べました。

README
README.1
README.asciidoc
README.creole
README.markdown
README.mediawiki
README.org
README.pod
README.rdoc
README.rst
README.textile
README.txt

複数の拡張子が許容されるケースがある（例えば .markdown は .md でも可）ようですが、

• https://github.com/github/markup/blob/master/lib/github/markups.rb

を見る限りは正規表現でチェックしているだけのようなので、最初のリストに挙がっている拡張子を選びました。

実験結果

以下の順序で使われていきました。

README.asciidoc
README.creole
README.markdown
README.mediawiki
README.org
README.pod
README.rdoc
README.rst
README.textile
README
README.txt

1. markup として定義されているものについて、そのファイル名順
2. README
3. README.txt

という優先順位になっているみたいですね。なお、README.1 については先頭ページの表示には利用されませんでした。

本当は Readme と readme、README が混在したようなケースも試したいところですが、今回調べたかったのは「ReadMe.txt があるリポジトリに README.md を置いたら後者が優先されるか」だったので、ここで調査終了、と。