跳转到主要内容
要在自定义域名上托管您的文档:
  1. 在控制台中添加您的 domain。
  2. 在您的域名服务商处配置 DNS(域名系统)设置。
  3. 等待 DNS 解析生效,并自动签发 TLS 证书。
想设置类似 mintlify.com/docs 的自定义子目录?请查看自定义子目录文档。

添加自定义域名

  1. 在控制台前往 Custom domain setup 页面。
  2. 输入你的域名,例如 docs.example.comwww.example.com
  3. 点击 Add domain
“Custom domain setup” 页面,显示用于输入自定义域名 URL 的字段。

配置你的 DNS(域名系统)

  1. 在你的域名提供商网站中,前往该域名的 DNS 设置。
  2. 使用以下值创建一条新的 DNS 记录:
CNAME | docs | cname.vercel-dns.com.
不同域名服务商添加 DNS(域名系统)记录的方式各不相同。请查阅你的域名服务商文档以获取具体操作说明。
在 Vercel 上托管的自定义域的 CNAME 设置示例。

DNS 传播

DNS 变更通常需要 1–24 小时在全球范围内生效,某些情况下可能长达 48 小时。你可以使用 DNSChecker 验证 DNS 是否配置正确。 DNS 记录生效后,你的文档最初将通过 HTTP 提供访问。Vercel 配置好你的 TLS 证书后,HTTPS 将可用。

自动配置 TLS

当你的 DNS(域名系统)记录完成传播并能正确解析后,Vercel 会使用 Let’s Encrypt 为你的 domain 自动签发免费的 SSL/TLS 证书。 通常在 DNS 传播后的数小时内即可完成,极少数情况下可能需要长达 24 小时。证书会在到期前自动续期。

CAA 记录

如果你的 domain 使用 CAA(Certification Authority Authorization)记录,你需要授权 Let’s Encrypt 为该 domain 签发证书。将以下 CAA 记录添加到你的 DNS(域名系统)设置中:
0 问题 "letsencrypt.org"

保留路径

用于证书验证的 /.well-known/acme-challenge 路径为保留路径,不能重定向或重写。若对该路径配置了重定向或重写,证书签发将失败。

特定服务商设置

如果 Vercel 是你的域名服务商,你需要添加一个用于验证的 TXT 记录。提交自定义域名后,这些信息会显示在你的控制台中,并通过电子邮件发送给你。
如果 Cloudflare 是你的 DNS(域名系统)服务商,你需要在 SSL/TLS 加密设置中启用“Full (strict)”模式。此外,请在 Edge Certificates 设置中禁用“Always Use HTTPS”。Cloudflare 的 HTTPS 重定向会在证书配置期间阻止 Let’s Encrypt 验证你的域名。

设置规范 URL

在配置好 DNS 后,设置一个规范 URL,以确保搜索引擎索引你首选的域名。规范 URL 会告诉搜索引擎哪一个版本的文档是主版本。当文档可通过多个 URL 访问时,这有助于提升 SEO(搜索引擎优化),并避免重复内容问题。 docs.json 中添加 canonical 元标签:
"seo": {
    "metatags": {
        "canonical": "https://www.your-custom-domain-here.com"
    }
}
https://www.your-custom-domain-here.com 替换为你的实际自定义 domain。举例来说,如果你的自定义 domain 是 docs.mintlify.com,你应使用:
"seo": {
    "metatags": {
        "canonical": "https://docs.mintlify.com"
    }
}