📝
GitHub の README はリポジトリのルートディレクトリ以外にも置ける
Twitter で以下のツイートを見かけました。
そこで調べてみたところ、 GitHub では次の場所に置かれている README を認識するようです。
.github/- リポジトリのルートディレクトリ
docs/
複数の README が含まれている場合は、 .github/ 、ルートディレクトリ、 docs/ の順に優先されます。
例えば冒頭のツイートの reduxjs/redux-toolkit は .github/ ディレクトリ内に README.md (正確には packages/toolkit/README.md へのシンボリックリンク) を置いています。
ほぇー知らんかったってなったのでついでに実際に挙動を見てみました。
挙動を見てみる
docs/README.md を作成します。
docs/README.md が表示されました。
docs/README.md が表示されている
ルートディレクトリに README.md を作成します。
ルートディレクトリの README.md が表示されました。
README.md が表示されている
.github/README.md を作成します。
.github/README.md が表示されました。
.github/README.md が表示されている
まとめ
ほぇーってなりました。
Discussion