使用 Vercel 在子路径下部署

配置你的 vercel.json 文件，将主域名的请求代理到文档所在的子路径。

vercel.json 文件用于配置项目的构建和部署方式。它位于项目的根目录，用来控制部署的各个方面，包括路由、重定向、请求头以及构建设置。

我们会在你的 vercel.json 文件中使用 rewrites 配置，将来自主域名的请求代理到你的文档站点。

Rewrites 会在不更改浏览器中 URL 的情况下，将传入请求映射到不同的目标。当有人访问 yoursite.com/docs 时，Vercel 会在内部从 your-subdomain.mintlify.site/docs 获取内容，但用户在浏览器中仍然看到的是 yoursite.com/docs。这与重定向不同，后者会将用户直接带到另一个完全不同的 URL。

1. 在控制台中前往 Custom domain setup。

2. 启用 Host at 开关。

3. 输入你的域名。

4. 输入 docs 作为你的基础路径。

5. 选择 Add domain。

6. 在你的 vercel.json 文件中添加以下重写规则。将 [subdomain] 替换为你的子域，它出现在控制台 URL 的末尾。例如，app.mintlify.com/your-organization/your-subdomain 的子域标识符是 your-subdomain。

   Copy Text

   {
     "rewrites": [
       {
         "source": "/docs",
         "destination": "https://[subdomain].mintlify.site/docs"
       },
       {
         "source": "/docs/:match*",
         "destination": "https://[subdomain].mintlify.site/docs/:match*"
       }
     ]
   }

rewrites 配置会将你域名上的 /docs 子路径映射到你的文档站点上的 /docs 子路径。

• source：你域名上触发重写的路径模式。
• destination：请求应被代理到的位置。
• :match*：用于捕获子路径之后任意路径片段的通配符。

如需了解更多信息，请参阅 Vercel 文档中的 Configuring projects with vercel.json: Rewrites。

要使用自定义子路径（任何非 /docs 的路径）：

1. 在控制台中前往 Custom domain setup 页面。
2. 启用 Host at 开关并输入你的基础路径。例如 /docs 或 /help。
3. 输入你的域名。
4. 输入你的基础路径。
5. 选择 Add domain。

然后使用下面的生成器创建你的重写规则配置，并将这些重写规则添加到你的 vercel.json 文件中。

Mintlify 会重新构建你的文档以在你的基础路径下提供服务，因此你的文档文件不需要位于与子路径相匹配的目录中。

{
  "rewrites": [
    {
      "source": "/_mintlify/:path*",
      "destination": "https://[SUBDOMAIN].mintlify.site/_mintlify/:path*"
    },
    {
      "source": "/api/request",
      "destination": "https://[SUBDOMAIN].mintlify.site/_mintlify/api/request"
    },
    {
      "source": "/[SUBPATH]",
      "destination": "https://[SUBDOMAIN].mintlify.site/[SUBPATH]"
    },
    {
      "source": "/[SUBPATH]/:path*",
      "destination": "https://[SUBDOMAIN].mintlify.site/[SUBPATH]/:path*"
    },
    {
      "source": "/mintlify-assets/:path+",
      "destination": "https://[SUBDOMAIN].mintlify.site/mintlify-assets/:path+"
    }
  ]
}