将README.md重命名为自定义名称并用作项目描述。

4

非常抱歉,如果已经有类似的问题,请见谅,但我没有找到。

我想将默认项目描述文件名(称为README.md)更改为自定义名称(比如说XXX.md),并且我想知道是否可以将XXX.md作为项目的初始自述文件(典型情况:您打开项目代码页面,并在底部看到XXX.md的内容)。

我想验证这种方法是否通用,但我主要关心Github和Bitbucket服务。我简要检查了项目设置,但我无法找到这样的自定义设置。这种做法是否可行?


1
对于GitHub,你可以将/.github/README.md软链接到你的XXX.md文件。参见https://stackoverflow.com/a/49981731/3775493。 - undefined
1个回答

5

至少在GitHub上,不能这样做。可以使用其他格式(如README.asciidocREADME.rst),但根文件必须称为README

请注意,您可以像这样包含其他文本标记文档,并且如果访问它们,则会呈现它们,只是它们不会像README一样显示在文件列表底部。


看起来Bitbucket使用了相同的方法(https://support.atlassian.com/bitbucket-cloud/docs/readme-content/) - Kube Kubow

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接