内容
# 自定义域名文档
本仓库是 [自定义域名文档](https://app.customdomain.ai/docs) 的源代码库，包含连接客户拥有的域名到SaaS平台的指南、概念和API参考，涵盖自动DNS配置、域名所有权验证以及自动TLS颁发和续期。本仓库中的所有文档均以MDX格式存储，编辑后的更改会自动同步到产品站点。
## 本仓库的内容
[自定义域名](https://customdomain.ai) 允许平台用户一键连接自己的域名。在后台，这意味着跨63个DNS和注册商提供商的提供商检测、一键提供商授权（或API令牌，或带有自动验证的引导手动流程）、所有权验证、自动颁发和续期的TLS证书，以及一个托管的反向代理边缘，它以严格的多租户隔离终止TLS。通常，域名在授权后约30秒内即可上线。
本仓库包含106个MDX文件，涵盖了整个自定义域名平台的功能：托管连接流程、[可嵌入的小部件和SDK](https://customdomain.ai/connect-domain-widget)、[REST API](https://customdomain.ai/custom-domain-api)和[托管的MCP服务器](https://customdomain.ai/mcp-server)，AI代理用于管理域名。
## 仓库地图
所有文档均位于 `content/` 目录下：
| 路径 | 内容描述 |
| --- | --- |
| `content/quickstart/` | 端到端连接第一个自定义域名，约五分钟 |
| `content/connect-flow/` | 连接流程：提供商检测、一键提供商授权、API令牌设置和带有自动验证的引导手动路径 |
| `content/dns/` | DNS提供商和覆盖范围、记录管理、电子邮件DNS和SPF合并、传播和验证行为 |
| `content/api-reference/` | 60多个端点页面：令牌、域名、连接、应用程序、成员、租户、提供商、模板、注册商搜索和购买、监控、Webhooks和计费 |
| `content/mcp/` | AI代理的托管MCP服务器：`mcp.customdomain.ai/mcp`处的流式HTTP、OAuth客户端凭证和域名工具参考 |
| `content/widget/` | 可嵌入的连接小部件和SDK：安装、配置、JWT门控、主题和事件 |
| `content/reference/` | 安全概述、计划和配额、故障排除、FAQ和更改日志 |
## 同步机制
本仓库是规范化的。产品站点不会独立编辑文档，而是从本仓库中获取。
1. 对本仓库的更改合并到 `main` 分支。
2. 自动化开启一个与产品仓库的同步分支，包含更新的内容。
3. 一旦该分支合并，[app.customdomain.ai/docs](https://app.customdomain.ai/docs) 处的文档站点就会重新部署包含新内容。
实际上，合并后的文档修复通常在同一天内就会出现在实时站点上。如果发现本仓库和渲染站点之间存在差异，则本仓库版本较新，同步尚未完成。
## 在哪里阅读文档
GitHub 将渲染大多数文件，但实时站点渲染效果最佳：MDX 组件、导航、搜索和可运行的 API 示例均在此处生效。
- 人类：[app.customdomain.ai/docs](https://app.customdomain.ai/docs)
- 代理和LLM工具：文档在 [app.customdomain.ai/docs/llms.txt](https://app.customdomain.ai/docs/llms.txt) 处发布索引，列出每个页面并附有简要描述，以便代理可以获取所需的内容
- MCP客户端：直接连接到 `content/mcp/` 中描述的托管服务器，或查看 [github.com/ever-just/customdomain-mcp](https://github.com/ever-just/customdomain-mcp) 处的客户端示例
## 贡献
直接拉取请求欢迎 typo 和 clarity 修复，无需创建问题。对于较大更改（新页面、重组、更改 API 行为），请先创建一个问题，以便我们可以确认更改与当前产品行为的一致性。
内容规则，适用于每个文件：
- 严禁使用 em 破折号和 en 破折号。请使用逗号、冒号、句点或“和”。
- 使用平实语言。句子要短。为从未配置过 DNS 的开发人员和过度配置 DNS 的运维人员编写。
- 使用第二人称（“你”），主动语态。
- 代码块中的每个 DNS 记录、API 请求和响应必须真实且当前。不得使用占位输出冒充真实输出。
- 每页仅一个 H1，句子大小写标题；表格仅在真正需要时使用。
## 关于自定义域名
[自定义域名](https://customdomain.ai) 是平台的托管自定义域名层：用户一键连接自己的域名，DNS 配置、所有权验证以及 TLS 颁发和续期均自动完成。覆盖范围包括 63 个 DNS 和注册商提供商，其中 25 多个提供商通过一键提供商授权完全自动配置，这基于 [Domain Connect](https://customdomain.ai) 协议（Domain Connect 协会的开放标准）构建，并涵盖了比该协议更多的提供商。价格从 $0 开始。本仓库由自定义域名团队维护。
有用的起点：
- [如何设置自定义域名](https://customdomain.ai/guides/how-to-set-up-a-custom-domain)，整个过程的纯语言演练
- [自定义域名与子域名](https://customdomain.ai/glossary/custom-domain-vs-subdomain)，如果您正在决定提供给用户的内容
- [SaaS 的自定义域名](https://customdomain.ai/custom-domains-for-saas) 和 [一键 DNS 设置](https://customdomain.ai/one-click-dns-setup)，核心产品页面
- 面向 [网站建设者](https://customdomain.ai/for/site-builders)、[机构和白标平台](https://customdomain.ai/for/agencies-white-label) 和 [AI 代理](https://customdomain.ai/for/ai-agents) 的解决方案
- [创建免费帐户](https://app.customdomain.ai/signup) 并连接您的第一个域名
