本指南帮助你将现有文档迁移到 Mintlify。受支持的平台可选择自动迁移;如需对整个过程保持完全控制,则可选择手动迁移。

选择迁移方式

自动迁移

如果你正从 Docusaurus、ReadMe 或 GitBook 迁移,请使用我们的工具自动完成迁移。

手动迁移

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

支持的平台

Docusaurus

ReadMe

GitBook(测试版)

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

安装爬虫

首先安装 @mintlify/scraping 包。
npm install @mintlify/scraping@latest -g

抓取页面和段落

迁移工具会自动检测你的文档平台并转换内容。生成的文件默认会本地保存到 ./docs 目录。对于大型文档站点,建议分阶段迁移较小模块,而不要一次性迁移整个站点。迁移整个章节:
mintlify-scrape 部分 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 仓库。

迁移后检查清单

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