Skip to main content
This guide helps you move your existing documentation to Mintlify. Choose automated migration for supported platforms or manual migration for complete control over the process.

​
Choose your migration path

  • If you currently use Docusaurus or ReadMe -> Automated migration
  • If you have a public GitHub repository -> Auto-generated migration
  • If you are migrating from any other platform -> Manual migration
Migrate your documentation using the @mintlify/scraping package. The package scrapes your content and converts it to use Mintlify components.

​
Supported platforms

Docusaurus

ReadMe

If you host your documentation on another platform, see the manual migration steps.

​
Installing the scraper

Install the @mintlify/scraping package to get started.
npm install @mintlify/scraping@latest -g

​
Scraping pages and sections

The migration tool automatically detects your documentation platform and converts your content. It saves prepared files locally in the ./docs folder by default.For large documentation sites, migrate smaller sections one at a time rather than the entire site at once.Migrate entire sections:
mintlify-scrape section https://your-docs-site.com/docs
Migrate single pages:
mintlify-scrape page https://your-docs-site.com/docs/getting-started
Filter specific paths:Use the --filter (or -f) option to scrape only URLs matching a specific path prefix.
mintlify-scrape section https://your-docs-site.com --filter=/docs
The filter matches the specified path and all nested paths. For example, --filter=/docs matches /docs, /docs/getting-started, /docs/api/reference, and so on.You can also use the CLI command:
mint scrape site https://your-docs-site.com --filter=/docs
Migrate OpenAPI specifications:
mintlify-scrape openapi-file [openApiFilename]

​
Add prepared content to your Mintlify project

After scraping your existing documentation platform, you are ready to build your docs on Mintlify.Confirm that you scraped all of your pages. Then add these files to the documentation repository that you created during the onboarding process. This is usually a GitHub repository.

​
Post-migration checklist

After completing your migration (automated or manual), we recommend checking:
  • All pages render
  • Navigation works as intended
  • Internal links resolve properly
  • Images and assets load correctly
  • Code blocks display with proper syntax highlighting
  • Search works
  • Correct deployment branch