能否将README.md重命名为自定义文件作为Github、Bitbucket项目说明?
你提出的自定义仓库默认展示说明文件名的需求,目前无法在GitHub、Bitbucket等主流代码托管平台原生实现,也没有跨平台通用的解决方案,具体说明如下:
GitHub 平台规则
- 平台固定识别仓库根目录下文件名为
README的文件作为首页默认展示内容,支持.md、.rst、.txt等多种格式后缀,但文件名前缀必须为README,未提供自定义修改的配置入口。 - 若你需要展示自定义命名的说明文件内容,仅能采用折中方案:在根目录保留
README.md文件,将自定义XXX.md的内容全部内嵌到该文件中,或添加引导说明提示用户查看自定义命名的说明文件。
Bitbucket 平台规则
- 无论是云版本还是本地部署版本的Bitbucket,仓库首页默认说明文件的匹配规则和GitHub完全一致,仅识别
README开头的根目录文件,无自定义文件名设置选项。同样可采用上述README内嵌内容的折中方案实现类似效果。
通用方案说明
目前包括GitLab、Gitee在内的绝大多数公开代码托管平台,都采用了固定识别README作为默认说明文件的规则,未开放自定义文件名的配置能力,没有可跨平台通用的原生支持方案。
内容的提问来源于stack exchange,提问作者Kube Kubow
相关产品推荐
相关产品推荐

