1. ホーム
  2. github

githubでフォルダごとのreadmeファイルを作成する方法はありますか?

2023-09-12 23:17:39

質問内容

Githubはreadme.txtまたはreadme.mdファイルを解析し、リポジトリのルートに表示します。

特定のフォルダのために同様のreadmeファイルを作成したいと思います。これを達成する方法はありますか?

私が考えた 1 つの醜いハックは、ファイルに _readmeme.md という名前を付けて、フォルダー内の最初のファイルとして表示させ、ユーザーがそれを見つけてクリックするのを容易にすることでした。 - ではうまくいかず、_README が表示されます。 最後の と表示され、最初には表示されません。

どのように解決するのですか?

GitHubにはすでにこの機能があります。 READMEファイルをサブディレクトリに置くだけで、ルートディレクトリにあるものと同じように表示されます。

例えば、このサブディレクトリのREADME.mdをご覧ください。 http://github.com/larsbrinkhoff/lbForth/tree/master/targets