文档自定义域名:docs.yourcompany.com 设置
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 分钟后仍处于“Pending”状态:
- 检查 DNS 是否已在全球范围内传播:
dig docs.yourcompany.com应解析到 CNAME 目标 - 移除阻止 Let's Encrypt 的任何 CAA 记录
- 检查您的域名是否已通过其他提供商提供 HTTPS 服务
重定向#
如果您之前在其他 URL 上托管文档,请设置 301 重定向以保留 SEO。
从 docs 子目录到新的子域名#
yourcompany.com/docs/* → docs.yourcompany.com/* (301)
大多数平台都通过重定向规则支持此功能。
从 GitBook v 路径到 Docsbook#
GitBook URL 通常具有 /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)
SEO 注意事项#
切换完成后需验证三件事:
搜索控制台#
将新域名添加到 Google 搜索控制台。提交站点地图(Docsbook 会自动生成 /sitemap.xml)。持续 4–6 周查看索引报告。
规范链接标签#
如果出于任何原因要保留旧网址作为备用,请在旧网址上设置规范链接标签,使其指向新网址。301 重定向更好,因为它不仅能转移读者,还能转移排名信号。
llms.txt 传播#
当你迁移域名时,AI 代理需要重新发现你的 llms.txt。它们通常会在几次抓取内完成。请验证:
curl https://docs.yourcompany.com/llms.txt | head -10请参阅完整的 llms.txt 指南。
用户有哪些变化#
- 指向旧 URL 的书签:由重定向处理
- 已保存的支持回复:更新它们
- 内部产品链接:更新它们
- 外部反向链接:保持不变(301 会传递权重)
除 URL 外,用户可见的体验不应发生变化。
各平台对自定义域名的支持#
| 平台 | 是否支持自定义域名 | 费用 |
|---|---|---|
| Docsbook | 支持,并自动提供 SSL | 无需付费 — 域名不会从项目余额中扣除费用;请参阅 docsbook.io/pricing |
| Mintlify | 支持 | 需要付费套餐 — 请参阅 mintlify.com/pricing |
| GitBook | 支持 | 需要付费套餐 — 请参阅 gitbook.com/pricing |
| ReadMe | 支持 | 需要付费套餐 — 请参阅 readme.com/pricing |
| GitHub Pages | 支持 | 免费 |
| Vercel / Netlify | 支持 | 提供免费层级,但每个账户有域名数量限制 |
此类别中的价格会变动;每个供应商自己的定价页面才是唯一可靠的信息来源。本表链接到所有供应商的定价页面,而不是重复列出可能过时的价格。
常见错误#
- 将顶级域名指向 CNAME — 大多数 DNS 提供商不允许这样做;请使用子域名(
docs.)或扁平化的 A 记录 - 忘记设置重定向 — 旧 URL 返回 404 → SEO 下降 → 权威性损失
- 未强制使用 HTTPS — 某些平台同时提供 HTTP 和 HTTPS;强制重定向到 HTTPS
- 多个
docs子域名 — 一次只能使用一个 CNAME,请先删除旧的
相关阅读#
Docsbook 为 docs.yourcompany.com 提供自动 SSL,且该域名不会从您的项目余额中扣费。