重定向
重定向的来源路径不能包含像
path#anchor 这样的 URL 锚点,或像 path?query=value 这样的查询参数。目标路径可以包含锚点(例如 /destination/path#section)。docs.json 文件的顶层添加 redirects 字段即可设置重定向。
docs.json
/source/path 重定向到 /destination/path。
默认情况下,重定向为永久重定向 (308)。若要使用临时重定向 (307),请将 permanent 设置为 false。
重定向数量限制
docs.json 中定义的重定向数量没有硬性上限。非常大的重定向数组 (数千条) 可能会拖慢部署速度并让文件难以审查,因此请尽可能使用通配符重定向进行合并。
通配符重定向
*。在此示例中,/beta/:slug* 可匹配 /beta/introduction,并将其重定向到 /v2/introduction。
部分通配符重定向
/articles/concepts- 的 URL,例如 /articles/concepts-getting-started 和 /articles/concepts-overview,并将它们全部重定向到 /collections/overview。
你也可以在目标地址中使用捕获到的通配符值进行替换。
/old/article-123 重定向到 /new/article-123,并在前缀之后保留捕获到的值。
避免无限重定向
重定向何时生效
docs.json 中的重定向会在请求时由 Mintlify 的托管层应用,因此一旦你的改动部署完成,它们就会立即生效。预览部署同样会应用重定向,便于你在合并到生产分支之前验证其行为。
要在本地测试重定向,请运行 mint dev,并在浏览器中访问源路径。本地开发服务器会应用你在 docs.json 中定义的重定向。