迁移到 Mintlify

使用 @mintlify/scraping 包迁移您的文档。该包会抓取您的内容并转换为 Mintlify 组件格式。

支持的平台Copy Anchor Link

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

安装爬虫工具Copy Anchor Link

安装 @mintlify/scraping 包即可开始使用。

npm install @mintlify/scraping@latest -g

抓取页面和部分Copy Anchor Link

迁移工具会自动检测您的文档平台并转换内容。处理后的文件默认保存在本地的 ./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 等。

迁移 OpenAPI 规范：

mintlify-scrape openapi-file [openApiFilename]

将准备好的内容添加到您的 Mintlify 项目Copy Anchor Link

抓取现有文档平台后,您就可以在 Mintlify 上构建文档了。

确认所有页面已完成抓取后，将这些文件添加到您在入门流程中创建的文档存储库。这通常是 GitHub 存储库。

Mintlify 可以为任何公开的 GitHub 存储库生成一个完整的文档站点，无论其中是否已经包含文档，还是只有代码。

在任何公开存储库的 URL 中，将 github.com 替换为 mintlify.com：

https://mintlify.com/github-owner/repository-name

Mintlify 会分析您的存储库并生成一个完整的文档站点，供您进一步自定义。

从任意平台迁移你的文档，并对整个流程保持完全掌控。

内容迁移Copy Anchor Link

要将内容迁移到 Mintlify，你需要：

• 一个有效的 docs.json，用于站点设置和导航。参见 全局设置 和 导航 了解更多信息。
• 每个文档页面对应一个 Markdown 文件 (.md 或 .mdx) 。推荐使用 MDX 格式。参见 页面 了解更多信息。
• (可选) 为你的 API 端点页面准备一份 OpenAPI 规范。参见 OpenAPI 设置 了解更多信息。

1. 如果你的内容已经是 Markdown 格式，将这些内容复制到你的 Mintlify 项目中。否则，将内容转换为 MDX 格式。
2. 创建 docs.json，并在其中引用你的 Markdown 页面路径。
3. 如果你有 OpenAPI 规范，将其添加到 docs.json 中，并配置 API 操作台。你还可以使用 @mintlify/scraping 包根据规范生成 MDX 页面：

npx @mintlify/scraping@latest openapi-file <openApiFilename> -o <folder-name>

资源迁移Copy Anchor Link

1. 将资源复制到存储库的 images/ 目录中。
2. 更新你在 Markdown 文件中的引用：

   Copy Text

   ![Alt text](/images/screenshot.png)