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

选择迁移路径

Automated migration

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

Manual migration

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

支持的平台

Docusaurus

ReadMe

GitBook(测试版)

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

安装爬虫

首先安装 @mintlify/scraping 包以开始使用。
npm install -g @mintlify/scraping@latest

抓取页面与部分

迁移工具会自动检测你的文档平台并转换内容。转换后的文件默认存储在本地的 ./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 [OpenAPI规范文件名]

将预备内容添加到你的 Mintlify 项目

抓取完你现有文档平台的内容后,就可以开始在 Mintlify 上构建文档了。确认所有页面均已迁移完成,然后将这些文件添加到你在入门流程中创建的文档代码库中。通常这是一个 GitHub 代码库。

迁移后检查清单

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