当你更改 docs 文件夹中文件的路径时,该页面的 URL 路径也会随之改变。这通常发生在重构文档或更改侧边栏标题时。
重定向不能包含像 path#anchor 这样的 URL 锚点,或像 path?query=value 这样的查询参数。
在 docs.json 文件中添加 redirects 字段即可设置重定向。
"redirects": [
{
"source": "/source/path",
"destination": "/destination/path"
}
]
这会将 /source/path 重定向到 /destination/path。
要匹配通配符路径,请在参数后面使用 *。在此示例中,/beta/:slug* 可匹配 /beta/introduction,并将其重定向到 /v2/introduction。
"redirects": [
{
"source": "/beta/:slug*",
"destination": "/v2/:slug*"
}
]
使用部分通配符来匹配以特定前缀开头的 URL 片段。
"redirects": [
{
"source": "/articles/concepts-*",
"destination": "/collections/overview"
}
]
这会匹配任何路径为 /articles/concepts- 的 URL,例如 /articles/concepts-getting-started 和 /articles/concepts-overview,并将它们全部重定向到 /collections/overview。
你也可以在目标地址中使用捕获到的通配符值进行替换。
"redirects": [
{
"source": "/old/article-*",
"destination": "/new/article-*"
}
]
该重定向会将 /old/article-123 重定向到 /new/article-123,并在前缀之后保留捕获到的值。
为避免出现无限循环,请不要创建路径彼此重定向的循环规则。
"redirects": [
{
"source": "/docs/:slug*",
"destination": "/help/:slug*"
},
{
"source": "/help/:slug*",
"destination": "/docs/:slug*"
}
]
使用 CLI 检测无效链接。