迁移概览
为将现有文档从 Docusaurus、ReadMe、GitBook、Fern、Document360 或其他平台迁移到 Mintlify 选择合适的迁移路径。
通过自动抓取工具、从当前平台导出,或手动迁移的方式,将你现有的文档迁移到 Mintlify。最合适的迁移路径取决于你的站点是否公开、你是否能访问其源文件,以及你使用了哪些平台特定的功能。
Docusaurus
抓取公开站点,或从源代码迁移以保留私有页面、带版本的文档、本地化内容和自定义 React 组件。
ReadMe
导出项目文件以保留私有内容和 OpenAPI 文件,或抓取公开站点以获得更快的起点。
GitBook
使用 Git Sync 导出每个 section 以获得最完整的迁移,或抓取公开站点。
Fern
从源仓库迁移 MDX、资源、API 规范和 docs.yml 配置。
Document360
将每个工作区和语言导出为项目 ZIP,包括文章、分类和媒体文件。
其他平台
对于其他平台或包含混合内容源的项目,遵循手动迁移工作流。
Docusaurus、ReadMe 和 GitBook 指南使用抓取工具的 section 命令,该命令会从你提供的 URL 出发,转换其可到达的每个页面。要仅转换单个页面,请从迁移目录中使用 page 命令。
npx @mintlify/scraping@latest page https://docs.example.com/getting-started使用 page 可以在完整运行前检查抓取工具如何转换你的内容,或填补 section 运行时遗漏的单个页面。对于大型站点,请使用 --filter 缩小 section 运行范围,而不是一次性抓取全部内容。
Mintlify 可以为任何 GitHub 仓库生成完整的文档站点,无论该仓库是否已包含文档,还是只包含代码。
将你仓库 URL 中的 github 替换为 mintlify。
https://github.com/org/repo -> https://mintlify.com/org/repo浏览 生成的文档站点 查看更多示例。
Was this page helpful?Suggest editsRaise issue