vercel.json 文件,将主域名的请求代理到文档所在的子路径。
vercel.json 文件
vercel.json 文件用于配置项目的构建和部署方式。它位于项目的根目录,用来控制部署的各个方面,包括路由、重定向、请求头以及构建设置。
我们会在你的 vercel.json 文件中使用 rewrites 配置,将来自主域名的请求代理到你的文档站点。
Rewrites 会在不更改浏览器中 URL 的情况下,将传入请求映射到不同的目标。当有人访问 yoursite.com/docs 时,Vercel 会在内部从 your-subdomain.mintlify.dev/docs 获取内容,但用户在浏览器中仍然看到的是 yoursite.com/docs。这与重定向不同,后者会将用户直接带到另一个完全不同的 URL。
配置
在 /docs 子路径下托管
- 在控制台中前往 Custom domain setup。
-
将 Host at
/docs开关切换到开启状态。
- 输入你的域名。
- 选择 Add domain。
-
在你的
vercel.json文件中添加以下重写规则。将[subdomain]替换为你的子域,可以在控制台 URL 的末尾找到。例如,dashboard.mintlify.com/your-organization/your-subdomain的子域标识符是your-subdomain。
rewrites 配置会将你域名上的 /docs 子路径映射到你的文档站点上的 /docs 子路径。
source:你域名上触发重写的路径模式。destination:请求应被代理到的位置。:match*:用于捕获子路径之后任意路径片段的通配符。
在自定义子路径下托管
使用自定义子路径需要 Custom 订阅方案并进行手动配置。请联系 Mintlify 支持,并提供你想要的子路径和托管设置的详细信息。
/docs 的路径),你必须在存储库中组织文档文件,使其与子路径结构相匹配。比如,如果你的文档托管在 yoursite.com/help,那么文档文件必须位于 help/ 目录中。
使用下面的生成器来创建你的 rewrites(重写规则)配置。将这些重写规则添加到你的 vercel.json 文件中。
