从 ReadMe 迁移

mkdir mintlify-migration
cd mintlify-migration
npx @mintlify/scraping@latest section https://your-project.readme.io

npx @mintlify/scraping@latest section https://your-project.readme.io --filter=/docs

docs/             按分类组织的 guides
reference/        API 参考页面和 OpenAPI 文件
recipes/          分步的 recipes
custom_pages/     Markdown 或 HTML 自定义页面
custom_blocks/    可复用的自定义 blocks
_order.yaml       文件夹或分类内的顺序

• Callouts、tabs、accordions、cards 和 code groups
• Reusable Content 和 Custom Blocks
• 变量和词汇表术语
• 交互式 recipes
• 自定义 HTML 页面
• 嵌入的 API explorer 和个性化内容

1. 在 reference/ 目录以及你曾经与 rdme 或 ReadMe API 同步一起使用的源仓库中，查找每个 JSON 或 YAML OpenAPI 文件。
2. 识别编辑者在规范之外的 ReadMe 中添加的 Markdown。ReadMe 通过 operationId 将这类内容与操作关联起来。
3. 将规范添加到你的 Mintlify 仓库中，并配置 OpenAPI 生成的页面。
4. 将有价值的补充 Markdown 移入相关的操作描述、schema 描述或相邻的指南中。
5. 将认证、服务器 URL、代码示例、示例和端点顺序与原始参考进行比较。

• 不同的默认版本和 URL 行为
• 隐藏、beta 和已弃用版本
• 特定版本的 Reusable Content
• 只在某一个版本中存在的页面
• 因版本而异的 API 规范
• 共享的 Custom Pages 或更新日志内容

• 省略了版本段的默认版本 URL
• 位于 /page 下的 Custom Pages
• 具有相同 slug 的 guides 和 reference 页面
• 从 OpenAPI 标签和摘要派生的端点路径
• 仍在接收流量的已弃用或隐藏页面

​

启动你的新站点

• 在旧站点上执行内容冻结，并跟踪迁移快照之后对其所做的每项更改。
• 在仪表板的 Git 设置 页面确认生产分支和仓库。
• 记录你现有的 DNS 记录，并在验证 Mintlify 部署已上线之前保持旧站点继续运行。
• 检查导航栏、页脚、favicon、logo、颜色和字体。
• 检查站点和页面的元数据、canonical URL 以及索引偏好设置。参见 SEO 和搜索设置。
• 安装所需的 分析集成，并可选择添加一个 自定义 404 页面。
• 如果你迁移了 API 参考，请将端点页面、导航结构、服务器 URL、认证方案和示例与旧站点进行比较。
• 在 预览部署 中预览你确切的启动提交。检查桌面和移动端布局、来自每个导航区段的页面、搜索以及重定向。
• 检查使用自定义组件或脚本的页面在浏览器控制台和网络标签页中是否有任何错误。
• 使用 自定义域名指南 切换你的域名，该指南涵盖了对已提供文档服务的域名的零停机切换。
• 启动后，监控 404 错误、重定向失败和构建失败。

• 导出数据
• 文档结构
• 版本管理
• OpenAPI 支持
• Reusable Content