要使用 Cloudflare 将文档托管在诸如 yoursite.com/docs 这样的子路径下，你必须创建并配置一个 Cloudflare Worker。
在开始之前，你需要一个 Cloudflare 账号和一个域名（可以在 Cloudflare 内或外进行管理）。
如果你的 DNS 提供商是 Cloudflare，请为该 CNAME 记录关闭代理，以避免潜在的配置问题。
/.well-known/acme-challenge/* - 用于 Let’s Encrypt 证书验证，必需/.well-known/vercel/* - 用于 Vercel domain 验证，必需
虽然 Cloudflare 会自动处理许多验证规则，但创建额外的自定义规则可能会无意中拦截这些关键流量。
请确保在你的 Worker 配置中正确转发 HOST 请求头。若未正确转发请求头，验证请求将会失败。
在你的 Cloudflare 控制台中，选择 Edit Code，然后将以下脚本添加到你的 Worker 代码中。有关编辑 Worker 的更多信息，请参阅 Cloudflare 文档。
将 [SUBDOMAIN] 替换为你唯一的子域，将 [YOUR_DOMAIN] 替换为你网站的基础 URL；如果希望使用不同的子路径，则将 /docs 替换为你想要的子路径。
addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
async function handleRequest(request) {
try {
const urlObject = new URL(request.url);
// 如果请求是 Vercel 验证路径,允许其通过
if (urlObject.pathname.startsWith('/.well-known/')) {
return await fetch(request);
}
// 如果请求是 docs 子路径
if (/^\/docs/.test(urlObject.pathname)) {
// 然后代理到 Mintlify
const DOCS_URL = "[SUBDOMAIN].mintlify.dev";
const CUSTOM_URL = "[YOUR_DOMAIN]";
let url = new URL(request.url);
url.hostname = DOCS_URL;
let proxyRequest = new Request(url, request);
proxyRequest.headers.set("Host", DOCS_URL);
proxyRequest.headers.set("X-Forwarded-Host", CUSTOM_URL);
proxyRequest.headers.set("X-Forwarded-Proto", "https");
// 如果部署到 Vercel,保留客户端 IP
proxyRequest.headers.set("CF-Connecting-IP", request.headers.get("CF-Connecting-IP"));
return await fetch(proxyRequest);
}
} catch (error) {
// 如果未找到操作,执行常规请求
return await fetch(request);
}
}
配置好 DNS（域名系统）后，自定义子域通常会在几分钟内生效。DNS 传播有时可能需要 1–4 小时，极少数情况下可达 48 小时。如果您的子域未能立即生效，请先耐心等待，再进行故障排查。
- 使用 Worker 的预览 URL 进行测试：
your-worker.your-subdomain.workers.dev/docs
- 确认该 Worker 能正确路由到你的 Mintlify 文档和你的网站。
- 在你的 Cloudflare 控制台中，进入你的 Worker。
- 前往 Settings > Domains & Routes > Add > Custom Domain。
- 添加你的 domain。
我们建议同时添加带有 www. 和不带有 www. 的 domain。
- 删除该 domain 的现有 DNS 记录。更多信息请参阅 Cloudflare 文档：Delete DNS records。
- 返回你的 Worker，添加你的自定义 domain。
如果你使用 Webflow 托管主站点，并希望在同一 domain 的 /docs 路径下提供 Mintlify 文档，你需要通过 Cloudflare Workers 配置自定义路由，将所有非 docs 流量代理到你的主站点。
在部署此 Worker 之前，请确保你的主站点已配置为某个落地页，否则访问你主站点的访客会看到错误。
- 在 Webflow 中，为你的主站点设置一个落地页，例如
landing.yoursite.com。这是访客访问你的网站时首先看到的页面。
- 将你的主站点部署到该落地页。这样可以确保在你配置 Worker 的过程中，主站点依然可访问。
- 为避免冲突，将主站点中的任何绝对 URL 更新为相对路径。
- 在 Cloudflare 中选择 Edit Code，并将以下脚本添加到你的 Worker 代码中。
将 [SUBDOMAIN] 替换为你唯一的子域，将 [YOUR_DOMAIN] 替换为你网站的基础 URL，将 [LANDING_DOMAIN] 替换为你的落地页 URL，如有需要，将 /docs 替换为你想要的其他子路径。
addEventListener("fetch", (event) => {
event.respondWith(handleRequest(event.request));
});
async function handleRequest(request) {
try {
const urlObject = new URL(request.url);
// 如果请求是 Vercel 验证路径,允许其通过
if (urlObject.pathname.startsWith('/.well-known/')) {
return await fetch(request);
}
// 如果请求是文档子路径
if (/^\/docs/.test(urlObject.pathname)) {
// 代理到 Mintlify
const DOCS_URL = "[SUBDOMAIN].mintlify.dev";
const CUSTOM_URL = "[YOUR_DOMAIN]";
let url = new URL(request.url);
url.hostname = DOCS_URL;
let proxyRequest = new Request(url, request);
proxyRequest.headers.set("Host", DOCS_URL);
proxyRequest.headers.set("X-Forwarded-Host", CUSTOM_URL);
proxyRequest.headers.set("X-Forwarded-Proto", "https");
// 如果部署到 Vercel,保留客户端 IP
proxyRequest.headers.set("CF-Connecting-IP", request.headers.get("CF-Connecting-IP"));
return await fetch(proxyRequest);
}
// 将其他所有请求路由到主站点
const MAIN_SITE_URL = "[LANDING_DOMAIN]";
if (MAIN_SITE_URL && MAIN_SITE_URL !== "[LANDING_DOMAIN]") {
let mainSiteUrl = new URL(request.url);
mainSiteUrl.hostname = MAIN_SITE_URL;
return await fetch(mainSiteUrl, {
method: request.method,
headers: request.headers,
body: request.body
});
}
} catch (error) {
// 如果未找到匹配操作,处理常规请求
return await fetch(request);
}
}
- 选择 Deploy，等待更改完成传播。
配置好 DNS（域名系统）后，自定义子域通常会在几分钟内生效。DNS 传播有时可能需要 1–4 小时，极少数情况下可达 48 小时。如果您的子域未能立即生效，请先耐心等待，再进行故障排查。
