收集源内容
- 来自源仓库的 Markdown 或 MDX 文件
- 来自当前平台的原生 Markdown 或 HTML 导出
- 通过当前平台的 API 获取的内容
- 来自已发布站点的渲染 HTML
- 手动复制和转换
创建 Mintlify 项目
- 用于站点设置和导航的
docs.json文件 - 用于非从 API 规范生成的页面的 Markdown 或 MDX 文件
- 你希望从仓库中托管的图片和可下载文件
- 可选的 OpenAPI 或 AsyncAPI 规范或 GraphQL schema，用于生成 API 文档
除非你打算隐藏该页面，否则将每个页面路径都添加到
docs.json。隐藏页面 仍可通过 URL 访问，但默认情况下会被排除在站点搜索、sitemaps、搜索引擎索引和 AI 上下文之外。
转换你的内容
在你转换后的文件中搜索源平台的指令、导入、模板变量、原始 HTML 和未解析的 include。这些模式通常会被渲染为文本，或在 MDX 构建时失败。
迁移 API 文档
迁移你的资源
- Markdown 图片和链接目标
- HTML
<img>和<video>元素 - CSS 背景图片
- 被导入组件所引用的资源
- 由旧文档提供商托管的文件
- 特定版本和特定语言的资源
保留 URL
- 迁移过程中被删除或合并的页面
- 版本和语言前缀
- 分类或 space 前缀
- 自定义着陆页
- API 端点页面
- 显式 slug 和旧的别名
重建站点功能
- 自定义域名和 DNS
- 认证和页面可见性
- 分析和标签管理器
- 搜索行为
- 自定义脚本和样式
- 反馈和支持集成
- 更新日志
- SEO 元数据、canonical URL 和索引规则
检查你的迁移
启动你的新站点
- 在旧站点上执行内容冻结，并跟踪迁移快照之后对其所做的每项更改。
- 在仪表板的 Git 设置 页面确认生产分支和仓库。
- 记录你现有的 DNS 记录，并在验证 Mintlify 部署已上线之前保持旧站点继续运行。
- 检查导航栏、页脚、favicon、logo、颜色和字体。
- 检查站点和页面的元数据、canonical URL 以及索引偏好设置。参见 SEO 和搜索设置。
- 安装所需的 分析集成，并可选择添加一个 自定义 404 页面。
- 如果你迁移了 API 参考，请将端点页面、导航结构、服务器 URL、认证方案和示例与旧站点进行比较。
- 在 预览部署 中预览你确切的启动提交。检查桌面和移动端布局、来自每个导航区段的页面、搜索以及重定向。
- 检查使用自定义组件或脚本的页面在浏览器控制台和网络标签页中是否有任何错误。
- 使用 自定义域名指南 切换你的域名，该指南涵盖了对已提供文档服务的域名的零停机切换。
- 启动后，监控 404 错误、重定向失败和构建失败。