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

​
选择迁移路径

  • 如果当前使用 Docusaurus 或 ReadMe -> 自动化迁移
  • 如果有公开的 GitHub 存储库 -> 自动生成的迁移
  • 如果从其他任意平台迁移 -> 手动迁移
使用 @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
过滤特定路径：使用 --filter（或 -f）选项仅抓取匹配特定路径前缀的 URL。
mintlify-scrape section https://your-docs-site.com --filter=/docs
过滤器匹配指定路径及其所有嵌套路径。例如，--filter=/docs 匹配 /docs、/docs/getting-started、/docs/api/reference 等。你也可以使用 CLI 命令：
mint scrape site https://your-docs-site.com --filter=/docs
迁移 OpenAPI 规范：
mintlify-scrape openapi-file [openApiFilename]

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

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

​
迁移后检查清单

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