Docsbook
概览

设置自定义域名

自定义域名会通过您拥有的地址提供 Docsbook 文档 — docs.example.com,而不是 docsbook.io/user/repo。DNS 解析完成后,Docsbook 会自动签发 SSL 证书。

网站的提供、域名和证书均不会调用 AI 模型,因此无论网站承载多少流量,自定义域名都不会消耗项目余额。

为什么要从您自己的域名提供文档#

  • 搜索权重会累积到您的域名。 人们为您的文档创建的链接会指向 example.com,因此这些链接带来的权重会落在您希望提升排名的域名上,而不是 docsbook.io 上。
  • 读者看到的是同一家公司。 地址栏中的地址与他们访问的产品相匹配。
  • 迁移后地址仍然有效。 如果您有一天离开 Docsbook,docs.example.com 仍可继续指向接替它的任何服务;而 docsbook.io/user/repo URL 则无法做到这一点。

开始之前#

您需要准备两样东西:

  1. 一个由您控制的域名,在任意注册商处注册。
  2. 访问该域名 DNS 设置的权限,以便添加一条记录。

第 1 步:打开自定义域名设置#

  1. 登录后打开您的文档。
  2. 点击右下角的浮动小部件。
  3. 打开设置自定义域名

第 2 步:输入您的域名#

  1. 输入您的域名,例如 docs.example.com
  2. 点击保存

Docsbook 会生成您所需的 DNS 记录并立即显示,每个值旁边都有一个复制按钮。

第 3 步:在您的注册商处添加 DNS 记录#

记录类型取决于您使用的是子域名还是域名根。

子域名 — 推荐,例如 docs.example.com。添加一条 CNAME 记录:

名称 / 主机 类型
docs(仅子域名) CNAME cname.vercel-dns.com

根域名或顶级域名 — 例如 example.com。大多数注册商不接受在根域名上使用 CNAME,因此请改为添加一条 A 记录:

名称 / 主机 类型
@ A 216.150.1.1

请从自定义域名面板复制这些值,而不是从此页面复制。该面板会显示适用于您的域名的确切目标;上面的值是通常的默认值,可能会有所不同。

常见注册商的 DNS 设置所在位置#

GoDaddy

  1. 登录 godaddy.com
  2. 转到 我的域名 → 您的域名 → DNS
  3. 点击 添加 并填写:类型 CNAME,名称 docs,指向 cname.vercel-dns.com
  4. 保存。

Namecheap

  1. 登录 namecheap.com
  2. 转到 域名列表管理高级 DNS
  3. 添加记录:类型 CNAME,主机 docs,值 cname.vercel-dns.com,TTL 3600
  4. 保存。

Ionos(原 1&1)

  1. 登录并打开 域名
  2. 选择您的域名并打开 管理 DNS
  3. 添加记录:类型 CNAME,子域名 docs,别名 cname.vercel-dns.com
  4. 保存。

其他注册商的操作方式相同:找到 DNS 或名称服务器面板,添加 Docsbook 面板中所示类型的记录,然后粘贴该值。

如果您希望使用根域名而不是子域名#

请尽可能使用 docs.example.com。这样更易于配置,并且可以为您的产品网站保留 example.com

如果确实需要根域名,请使用上面的 A 记录——复制 Custom Domain 面板中显示的确切 IP——如果您的域名注册商界面不提供该选项,请写信至 support@docsbook.io

第 4 步:等待 DNS 传播#

DNS 更改通常需要 15–30 分钟才能显示,最长可能需要 48 小时。

自定义域名 面板中点击 检查域名状态。它会显示以下三种状态之一:

状态 含义 操作
域名已验证(绿色) DNS 已解析,域名已上线 无需操作;打开网站
等待 DNS 验证(黄色) 记录尚未显示 等待 15–60 分钟后再次检查
发现冲突的 DNS 记录(黄色) 同一名称下的另一条记录造成了干扰 删除冲突记录后再次检查

要从 Docsbook 外部进行确认,请运行查询:

nslookup docs.example.com

结果应显示 cname.vercel-dns.comDNSChecker 会同时显示来自多个国家的相同结果,这在传播尚未完成时非常有用。

第 5 步:让 SSL 证书签发#

DNS 解析完成后,Docsbook 会检测域名、请求 Let's Encrypt 证书并启用 HTTPS。无需点击任何内容。

随后,您的文档将通过以下地址提供:

https://docs.example.com

故障排除#

两小时后域名仍然无法使用
  1. DNSChecker 中检查记录 — 如果 այնտեղ不可见,则记录错误或未保存。
  2. 确认记录类型和值与“自定义域名”面板中的内容完全匹配。
  3. 在隐私浏览器窗口中打开网站,这样可以跳过本地缓存。
  4. 在判定失败之前,最多等待 48 小时。
旧网站仍然显示

浏览器缓存了旧版本。按下 Ctrl+F5(macOS 上按 Cmd+Shift+R),或打开隐私窗口。如果旧版本持续显示超过 24 小时,请在面板中检查域名状态。

HTTPS 显示证书错误

DNS 解析完成后才会签发证书,因此新域名在 HTTPS 准备就绪前可能会提供 HTTP。等待一小时,确认 DNS 已完成传播,并检查域名是否有拼写错误。如果问题仍然存在,请写信至 support@docsbook.io

域名显示 Vercel 错误页面

域名已解析,但尚未完成关联。在 设置自定义域名 中点击 检查域名状态,确认域名已保存在 Docsbook 中,并确认 DNS 记录匹配。等待一到两小时,让两端完成同步。

Cloudflare 代理阻止验证

将 DNS 记录设置为 仅 DNS — 即灰色云朵,而不是橙色云朵。橙色云朵会在域名完成验证前代理流量,从而导致域名始终无法验证或出现 SSL 错误。切换为灰色云朵,然后再次点击 检查域名状态

更改或移除域名#

要迁移到其他域名:打开设置自定义域名,替换该值,点击保存,然后为新域名添加 DNS 记录。旧域名将停止提供文档服务。

要返回 Docsbook 地址:清空自定义域名字段,然后点击保存。您的文档将返回到 docsbook.io/username/repo

域名上线后#

  • 更新所有指向旧地址的链接 — 包括你的 GitHub README、产品网站、电子邮件签名和社交资料。保留在旧地址上的链接会将权重传递给 docsbook.io
  • 按用途优先使用子域名docs.example.comguide.example.comapi.example.com。将文档放在根域名上会与主站竞争。
  • 关注到达的流量。 Web 分析 从首次访问起报告新域名的浏览量、引荐来源和搜索查询。

后续步骤#

Updated

此页面对您有帮助吗?