The migration CLI automatically migrates your v1 website to a v2 website.
Manual work is still required after using the migration CLI, as we can't automate a full migration
The migration CLI migrates:
- Site configurations (from
/versioned_docsif your site uses versioning
To use the migration CLI, follow these steps:
Before using the migration CLI, ensure that
package.jsonfollow the structure shown at the start of this page.
To migrate your v1 website, run the migration CLI with the appropriate filesystem paths:
# migration command formatnpx @docusaurus/migrate migrate <v1 website directory> <desired v2 website directory> # examplenpx @docusaurus/migrate migrate ./v1-website ./v2-website
- To view your new website locally, go into your v2 website's directory and start your development server.
cd ./v2-websiteyarn installyarn start
The migration CLI updates existing files. Be sure to have committed them first!
You can add option flags to the migration CLI to automatically migrate Markdown content and pages to v2. It is likely that you will still need to make some manual changes to achieve your desired result.
|Add this flag to convert Markdown to MDX automatically|
|Add this flag to migrate pages automatically|
# example using optionsnpx @docusaurus/migrate migrate --mdx --page ./v1-website ./v2-website
The migration of pages and MDX is still a work in progress.
We recommend you to try to run the pages without these options, commit, and then try to run the migration again with the
This way, you'd be able to easily inspect and fix the diff.