markdown 格式语法中,链接的格式是:

1
[链接文字](链接地址)

之前写链接,用 http 协议 url 居多,最近遇到在项目的 README 中要添加另一个文档的链接,由于当前在 dev 分支,如果写分支的仓库 url 路径,那到时候 dev 分支合并到其他分支后,dev 分支被删除后,这个地址岂不是有问题了。如果能用相对路径就好了。

查了下,居然在 gitlab 上是支持的,在 github 上最近也支持了,真是喜讯。说到喜讯,昨天 github 官网宣布开放免费的 private repository ,也是2019喜讯一桩。

相对路径使用举例

如果你的项目结构如下:

1
2
3
4
5
6
7
8
project/
text.md
subpro/
subtext.md
subsubpro/
subsubtext.md
subsubpro2/
subsubtext2.md

那么在 text.md 中链接到 subtext.md 的相对链接这么写:

1
[this subtext](subpro/subtext.md)

在 text.md 中链接到 subsubtext.me 的相对链接这么写:

1
[this subsubtext](subpro/subsubpro/subsubprotext.md)

在 subsubtext.md 中链接到 text.md 的相对链接这么写:

1
[this text](../../text.md)