mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
4b465465dd
Generated-By: mintlify-agent Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
118 lines
2.7 KiB
Plaintext
118 lines
2.7 KiB
Plaintext
---
|
||
title: "重定向"
|
||
description: "在 docs.json 中配置 URL 重定向，为已移动、重命名或删除的文档页面保护 SEO 排名并防止失效链接。"
|
||
keywords: ["redirects"]
|
||
boost: 3
|
||
---
|
||
|
||
当你更改 docs 文件夹中文件的路径时，该页面的 URL 路径也会随之改变。这通常发生在重构文档或更改侧边栏标题时。
|
||
|
||
<div id="redirects">
|
||
## Redirects
|
||
</div>
|
||
|
||
<Note>
|
||
重定向**不能**包含像 `path#anchor` 这样的 URL 锚点，或像 `path?query=value` 这样的查询参数。
|
||
</Note>
|
||
|
||
在 `docs.json` 文件中添加 `redirects` 字段即可设置重定向。
|
||
|
||
```json
|
||
"redirects": [
|
||
{
|
||
"source": "/source/path",
|
||
"destination": "/destination/path"
|
||
}
|
||
]
|
||
```
|
||
|
||
该重定向会将 `/source/path` 重定向到 `/destination/path`。
|
||
|
||
默认情况下，重定向为永久重定向 (308)。若要使用临时重定向 (307)，请将 `permanent` 设置为 `false`。
|
||
|
||
```json
|
||
"redirects": [
|
||
{
|
||
"source": "/source/path",
|
||
"destination": "/destination/path",
|
||
"permanent": false
|
||
}
|
||
]
|
||
```
|
||
|
||
307 和 308 都保留原始请求的 HTTP 方法 (不同于 301 和 302) ，因此适合用于重定向 POST 请求。
|
||
|
||
<div id="wildcard-redirects">
|
||
### 通配符重定向
|
||
</div>
|
||
|
||
要匹配通配符路径，请在参数后面使用 `*`。在此示例中，`/beta/:slug*` 可匹配 `/beta/introduction`，并将其重定向到 `/v2/introduction`。
|
||
|
||
```json
|
||
"redirects": [
|
||
{
|
||
"source": "/beta/:slug*",
|
||
"destination": "/v2/:slug*"
|
||
}
|
||
]
|
||
```
|
||
|
||
<div id="partial-wildcard-redirects">
|
||
### 部分通配符重定向
|
||
</div>
|
||
|
||
使用部分通配符来匹配以特定前缀开头的 URL 片段。
|
||
|
||
```json
|
||
"redirects": [
|
||
{
|
||
"source": "/articles/concepts-*",
|
||
"destination": "/collections/overview"
|
||
}
|
||
]
|
||
```
|
||
|
||
这会匹配任何路径为 `/articles/concepts-` 的 URL，例如 `/articles/concepts-getting-started` 和 `/articles/concepts-overview`，并将它们全部重定向到 `/collections/overview`。
|
||
|
||
你也可以在目标地址中使用捕获到的通配符值进行替换。
|
||
|
||
```json
|
||
"redirects": [
|
||
{
|
||
"source": "/old/article-*",
|
||
"destination": "/new/article-*"
|
||
}
|
||
]
|
||
```
|
||
|
||
该重定向会将 `/old/article-123` 重定向到 `/new/article-123`，并在前缀之后保留捕获到的值。
|
||
|
||
<div id="avoid-infinite-redirects">
|
||
### 避免无限重定向
|
||
</div>
|
||
|
||
为避免出现无限循环，请不要创建路径彼此重定向的循环规则。
|
||
|
||
```json
|
||
"redirects": [
|
||
{
|
||
"source": "/docs/:slug*",
|
||
"destination": "/help/:slug*"
|
||
},
|
||
{
|
||
"source": "/help/:slug*",
|
||
"destination": "/docs/:slug*"
|
||
}
|
||
]
|
||
```
|
||
|
||
<div id="check-for-broken-links">
|
||
## 检查无效链接
|
||
</div>
|
||
|
||
使用 [CLI](/zh/cli) 检测无效链接。
|
||
|
||
```bash
|
||
mint broken-links
|
||
```
|