跳转到主要内容
本指南将帮助你将现有文档迁移至 Mintlify。对受支持的平台，可选择自动迁移；若希望对流程拥有完全掌控，则可选择手动迁移。

​
选择你的迁移路径

自动迁移

如果你从 Docusaurus 或 ReadMe 迁移，请使用我们的工具实现自动迁移。

手动迁移

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

​
支持的平台

Docusaurus

README

如果您的文档托管在其他平台上,请参阅手动迁移步骤。

​
安装爬虫工具

安装 @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 存储库。

​
迁移后检查清单

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