Docsbook
概览

设置自定义域名

使用您自己的域名代替 docsbook.io 来进行文档编写。

必需：高级订阅（一次性费用 $29）

为什么使用自定义域名?#

Benefits#

  • 🎯 品牌 — 您自有域名下的文档
  • 📈 SEO — 链接到您的域名可以提高您的排名
  • 🔐 信任 — 访问者看到您的域名，而不是别人的
  • 💼 专业性 — 看起来像您自己的产品

示例#

❌ Without domain:
docsbook.io/mycompany/product

✅ With domain:
docs.mycompany.com

Requirements#

  1. 自己的域名 — 由您注册

    • 如果您还没有域名 — 在 GoDaddy、Namecheap 或其他注册商处购买

  2. 高级订阅 — 29 美元一次性

  3. 访问 DNS 设置 — 在您的域名注册商处

步骤 1：打开设置#

  1. 登录后查看您的文档
  2. 点击右下角的浮动小部件
  3. 打开 设置

步骤 2：输入您的域名#

在 自定义域名 部分：

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

Docsbook 将生成 DNS 配置。

步骤 3：更新 DNS#

Docsbook 将提供说明：

Add a CNAME record:
Type:  CNAME
Name:  docs (or @)
Value: cname.vercel-dns.com

在哪里更改 DNS？#

打开您的域名注册商的控制面板：

GoDaddy#

  1. 打开 godaddy.com → 登录
  2. 我的域名 → 选择域名 → DNS
  3. 点击 DNS 旁边的“添加”
  4. 填写：
    • 类型：CNAME
    • 名称：docs
    • 指向：cname.vercel-dns.com
  5. 保存

Namecheap#

  1. 打开 namecheap.com → 登录
  2. 域名列表 → 管理
  3. 高级 DNS
  4. 添加新记录：
    • 类型：CNAME
    • 主机：docs
    • 值：cname.vercel-dns.com
    • TTL：3600
  5. 保存

Google Domains#

  1. 打开 domains.google.com
  2. 选择域名
  3. DNS → 自定义记录
  4. 创建新记录：
    • DNS 记录类型：CNAME
    • 名称：docs
    • 数据：cname.vercel-dns.com
  5. 保存

1and1 / Ionos#

  1. 登录 → 域名
  2. 选择域名
  3. 管理 DNS
  4. 添加记录：
    • 类型：CNAME
    • 子域名：docs
    • 别名：cname.vercel-dns.com
  5. 保存

使用根域名#

如果您想 example.com (没有 docs):

  1. 我们的建议：使用 docs.example.com

    • 配置更容易
    • 让您可以使用 example.com 用于项目站点

  2. 如果您仍然想要根域名：

    • 某些注册商不允许在根域名上使用 CNAME
    • 使用 A 记录代替 CNAME: 76.76.19.0
    • 联系 support@docsbook.io 寻求帮助

步骤 4：等待#

添加 DNS 记录后，更新会传播：

  • 通常： 15-30 分钟
  • 最长： 48 小时
  • 检查状态： 使用 DNSChecker

输入您的域名 → 应该显示 cname.vercel-dns.com

步骤 5：SSL 证书#

DNS 传播后，Docsbook 会自动：

  1. 检测您的域名
  2. 创建 SSL 证书 (Let's Encrypt)
  3. 启用 HTTPS

您的站点可在：

https://docs.example.com ✅

验证您的域名#

如何检查一切是否正常运作？#

方法 1：简单检查

  1. 在浏览器中打开：https://your-domain.com
  2. 您的文档应加载完成

方法 2：DNS 检查

# In terminal
nslookup docs.example.com
# Should show: cname.vercel-dns.com

方法 3：在线服务

  1. 打开 mxtoolbox.com
  2. CNAME 查找
  3. 输入您的域名
  4. 应显示 cname.vercel-dns.com

故障排除#

DNS Not Updating#

Problem: 2+ hours have passed, but domain doesn't work

Solutions:

  1. 清除浏览器缓存 (Ctrl+Shift+Delete)
  2. 使用私有浏览器窗口
  3. 通过 DNSChecker 检查 DNS
  4. 验证 CNAME 记录是否添加正确
  5. 等待 24 小时

旧站点仍然显示#

问题: DNS 已更新，但站点旧版本

解决方案:

  1. 按下 Ctrl+F5 (完全清除缓存)
  2. 在私有窗口中打开
  3. 等待 24 小时

HTTPS Not Working#

问题: https:// 显示证书错误

解决方案:

  1. 等待 1 小时 — 证书正在创建中
  2. 确保 DNS 已更新
  3. 检查域名是否存在拼写错误
  4. 联系 support@docsbook.io

Domain Shows Vercel or Error#

问题: 访问域名显示 Vercel 消息

解决方案:

  1. 检查域名是否已添加到 Docsbook (在设置中可见)
  2. 确保 DNS CNAME 正确
  3. 等待 1-2 小时以进行同步

更改您的域名#

如何切换到另一个?#

  1. 打开设置
  2. 在 自定义域名 字段中更改域名
  3. 点击保存
  4. 更新新域名的 DNS
  5. 旧域名将停止工作

移除您的域名#

如何返回到 docsbook.io?#

  1. 打开设置
  2. 清除 自定义域名 字段
  3. 点击保存

文档返回到：

docsbook.io/username/repo

最佳实践#

1. 使用子域名#

✅ docs.example.com
✅ guide.example.com
✅ api.example.com

❌ example.com (if your main site is there)

2. 告知人们关于域名#

更新您文档的链接，在所有地方：

  • GitHub README
  • 项目网站
  • 电子邮件签名
  • 社交媒体

3. 设置电子邮件 (可选)#

现在您已经拥有域名，您可以添加电子邮件：

这与 Docsbook 是一个单独的服务，通过您的注册商进行配置。

4. Use for SEO#

现在您的网站已在您的域名下:

  • 设置 Google Analytics
  • 跟踪流量
  • 提交到搜索引擎

下一步是什么?#

由...提供支持 Docsbook