文档的自定义域名
docs.yourcompany.com 看起来比 docsbook.io/yourorg/yourrepo 更专业。这对 SEO、信任以及“这真的是一个产品吗”的第一印象也很重要。这是正确设置它的方法。
简而言之#
- 决定子域名 (
docs.yourcompany.com) 与子目录 (yourcompany.com/docs/) - 在DNS中添加指向您的文档主机的CNAME或A记录
- 等待SSL配置(通常在5分钟内)
- 从任何先前的URL设置重定向
- 更新内部链接和外部提及
子域名与子目录#
SEO 争论是真实存在的。两者在 2026 年都有效,但它们有不同的权衡。
子域名 (docs.yourcompany.com) |
子目录 (yourcompany.com/docs/) |
|
|---|---|---|
| 设置复杂性 | 更简单(一个 DNS 记录) | 更复杂(反向代理或共享平台) |
| SEO 权威 | 主要继承自根域名 | 完全继承 |
| 托管灵活性 | 独立于主站点 | 共享主站点基础设施 |
| 品牌一致性 | 清晰分离 | 紧密耦合 |
| 2026 年常见 | 大多数文档网站 | Stripe, GitHub, AWS |
对于大多数团队来说,子域名更容易,SEO 差异很小。只有在您的主站点位于支持干净反向代理文档的平台上时,才使用子目录。
设置子域名(Docsbook 示例)#
三个步骤:
1. 在 Docsbook 仪表板#
- 打开您的工作区设置
- 设置 → 域
- 输入
docs.yourcompany.com - 点击保存
仪表板显示您需要添加的 DNS 记录。
2. 在您的 DNS 提供商中#
添加 CNAME 记录:
Type: CNAME
Name: docs
Value: cname.vercel-dns.com
TTL: 300 (or default)
如果您的 DNS 提供商不支持根目录的 CNAME(Cloudflare 的扁平化或类似功能),请使用您的平台提供的 A 记录替代方案。
3. SSL#
SSL 是自动的。Docsbook(通过 Vercel)在 5 分钟内提供 Let's Encrypt 证书。您将在仪表板中看到“活动”状态。
总时间:通常为 5–15 分钟,包括 DNS 传播。
当 SSL 需要更长时间#
如果 SSL 在 30 分钟后仍然显示“待处理”:
- 检查 DNS 是否已全球传播:
dig docs.yourcompany.com应该解析到 CNAME 目标 - 删除任何阻止 Let's Encrypt 的 CAA 记录
- 检查您的域名是否已经从其他提供商提供 HTTPS
重定向#
如果您之前在不同的 URL 上托管文档,请设置 301 重定向以保留 SEO。
从文档子目录到新子域名#
yourcompany.com/docs/* → docs.yourcompany.com/* (301)
大多数平台通过重定向规则支持此功能。
从 GitBook v-paths 到 Docsbook#
GitBook URLs 通常具有 /v/1.0/ 模式:
docs.yourcompany.com/v/1.0/api/auth → docs.yourcompany.com/api/auth (301)
如果您在域名前使用 Cloudflare,您可以通过单个页面规则来实现。请参见 从 GitBook 迁移到 Docsbook。
从 Docusaurus 前缀到根#
Docusaurus 通常使用 /docs/intro 路径。如果你扁平化到根:
docs.yourcompany.com/docs/* → docs.yourcompany.com/* (301)
请参见 从 Docusaurus 迁移到 Docsbook。
SEO考量#
切换后需要验证的三件事:
搜索控制台#
将新域添加到 Google 搜索控制台。提交网站地图(Docsbook 自动生成 /sitemap.xml)。观察索引报告 4-6 周。
规范标签#
如果您出于任何原因保持旧网址的在线状态作为后备,请在指向新网址的旧网址上设置规范标签。更好的是:直接使用301重定向。
llms.txt 传播#
当您移动域名时,AI 代理需要重新发现您的 llms.txt。它们通常在几次爬取内完成。请验证:
curl https://docs.yourcompany.com/llms.txt | head -10请参阅 完整的 llms.txt 指南。
用户的变化是什么#
- 旧网址的书签:通过重定向覆盖
- 保存的支持回复:更新它们
- 内部产品链接:更新它们
- 外部反向链接:保持不变(301转移权威)
用户可见的体验不应超出网址的变化。
平台的自定义域名支持#
| 平台 | 免费版自定义域名 | 付费版自定义域名 |
|---|---|---|
| Docsbook | 否 | PRO ($150 终身), PRO+ ($59/月) |
| Mintlify | 否 | 是 ($150+/月) |
| GitBook | 否 | 是 (付费计划, 每个编辑器) |
| ReadMe | 否 | 是 ($99+/月) |
| GitHub Pages | 是 | 是 |
| Vercel/Netlify | 是 (Vercel 免费版每个账户 50 个) | 是 |
对于托管文档平台,自定义域名是一个付费功能。Docsbook 的终身 PRO 选项为 $150,是可比选项中最便宜的。
常见错误#
- 将顶级域名指向CNAME — 大多数DNS提供商不允许这样;使用子域名 (
docs.) 或扁平化的A记录 - 忘记重定向 — 旧的URL 404 → SEO下降 → 权威性丧失
- 未强制使用HTTPS — 一些平台同时提供HTTP和HTTPS;强制重定向到HTTPS
- 多个
docs子域名 — 一次只能有一个CNAME,先删除旧的
相关阅读#
Docsbook 支持 docs.yourcompany.com,在 PRO 上提供免费 SSL($150 终身)。 查看定价 →