告诉github使用自定义文件显示为项目的自述文件

问题描述 投票:0回答:2

有没有办法告诉github该项目的自述文件不是README.md而是<project-name>.md

github
2个回答
0
投票

The GitHub documentation声明GitHub将专门显示名为README.md的文件的内容,该文件存在于项目的根目录或.githubdocs子目录中。

这里似乎没有替代方案,但您可以使您的README.md文件只包含指向您选择的另一个页面的链接。


0
投票

创建一个名为.github的目录并在那里添加README.md,但不是普通文件。使用符号链接到您想要成为自述文件的文件。

 $ mkdir .github
 $ cd .github
 $ ln -s ../project-name.md ./README.md
 $ git add README.md
© www.soinside.com 2019 - 2024. All rights reserved.