如何在GitHub的Markdown中为子模块中的文件添加相对链接?

19

我在我的存储库的README文件中使用Markdown。

对于相同存储库中的文件,相对链接有效。

但是我想要链接一个子模块中的文件(以便显示与子模块相同的版本)。

用例如下:我有一个子模块在external/fancy-lib。 在我的存储库的README.md中,我想添加"请参阅fancy-lib的[README](external/fancy-lib/README.md)以获取有关所需软件包的信息",但它会生成不存在的链接。

从fancy-lib的存储库中添加到fancy-lib的README的链接将指向HEAD,这不一定是包含在我的存储库中的相同版本。 另一方面,手动更新每次子模块更新到新版本(git pull)时的链接是维护的负担。

有什么解决方法吗?


你可以尝试使用普通的 [link](../external/fancy-lib/README.md),但我不确定它是否适用于子模块。 - ahmet alp balkan
我假设外部目录是在上一级,如果不是的话,你根本不需要使用 ..。另外请查看:https://dev59.com/aGsz5IYBdhLWcg3wy7HU?rq=1 - ahmet alp balkan
1个回答

1

我认为相对链接可能不起作用。但是可以始终使用完整的URL,该URL类似于

![](https://raw.githubusercontent.com/<account>/<name of submodule repo>/README.md)

或者

https://github.com/<account>/<repo>/blob/<hash>/README.md

1
我明确提到“相对”,因为我想避免这种情况。 - fferri
顺便说一句,由于子模块指向特定版本,完整的URL看起来像这样:https://github.com/<account>/<repo>/blob/<hash>/README.md - fferri

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