跳转到主要内容
本指南将帮助你把现有文档迁移到 Mintlify。对于受支持的平台，你可以选择自动迁移；若需要对整个流程进行完全掌控，则可选择手动迁移。

​
选择迁移路径

自动迁移

如果你正在从 Docusaurus、ReadMe 或 GitBook 迁移，可使用我们的工具实现自动迁移。

手动迁移

如果你正在从其他平台迁移，请按照我们的指南迁移你的内容。
  • 自动化迁移
  • 手动迁移
使用 @mintlify/scraping 包 迁移您的文档。该包会抓取您的内容并将其转换为使用 Mintlify 组件。

​
支持的平台

Docusaurus

ReadMe

GitBook（测试版）

如果您的文档托管在其他平台上，请查看手动迁移步骤。

​
安装爬虫工具

安装 @mintlify/scraping 包来开始。
npm install @mintlify/scraping@latest -g

​
抓取页面和章节

迁移工具会自动检测您的文档平台并转换您的内容。准备好的文件默认存储在本地的 ./docs 中。对于大型文档站点，建议分批迁移较小的部分，而不是一次性迁移整个站点。迁移整个章节：
mintlify-scrape section https://your-docs-site.com/docs
迁移单个页面：
mintlify-scrape page https://your-docs-site.com/docs/getting-started
迁移 OpenAPI 规范：
mintlify-scrape openapi-file [openApiFilename]

​
将准备好的内容添加到您的 Mintlify 项目中

在抓取现有文档平台的内容后，您就可以在 Mintlify 上构建文档了。确认所有页面都已迁移完成，然后将这些文件添加到您在入门过程中创建的文档存储库中。这通常是一个 GitHub 存储库。

​
迁移后检查清单

完成迁移（自动或手动）后，建议检查：
  • 所有页面均能正常渲染
  • 导航按预期工作
  • 内部链接能正确解析
  • 图片和资源加载正常
  • 代码块语法高亮显示正常
  • 搜索功能可用
  • 部署已配置
  • 已设置自定义域名
⌘I