8f47babb46
* stable refactor of plugins api documentation * plugins sidebar not collapsed by default as small? * theme docs reorg * Refactor migration guide doc * fix broken link
2.4 KiB
| id | title | slug |
|---|---|---|
| migration-overview | Migration overview | /migration |
:::caution
For v1 translated sites, the migration doc is not available yet.
:::
This doc guides you through migrating an existing Docusaurus 1 site to Docusaurus 2.
We try to make this as easy as possible, and provide a migration cli.
Docusaurus 1 structure
Your Docusaurus 1 site should have the following structure:
├── docs
└── website
├── blog
├── core
│ └── Footer.js
├── package.json
├── pages
├── sidebars.json
├── siteConfig.js
└── static
Docusaurus 2 structure
After the migration, your Docusaurus 2 site should look like:
website
├── blog
├── docs
├── src
│ ├── components
│ ├── css
│ └── pages
├── static
├── package.json
├── sidebars.json
├── docusaurus.config.js
Migration process
There are multiple things to migrate to obtain a fully functional Docusaurus 2 website:
- packages
- cli commands
- site configuration
- markdown files
- sidebars file
- pages, components and CSS
- versioned docs
- i18n support 🚧
Automated migration process
The migration cli will handle many things of the migration for you.
However, some parts can't easily be automated, and you will have to fallback to the manual process.
:::note
We recommend running the migration cli, and complete the missing parts thanks to the manual migration process.
:::
Manual migration process
Some parts of the migration can't be automated (particularly the pages), and you will have to migrate them manually.
The manual migration guide will give you all the manual steps.
Support
For any questions, you can ask in the #docusaurus-1-to-2-migration Discord channel.
Feel free to tag @slorber in any migration PRs if you would like us to have a look.
We also have volunteers willing to help you migrate your v1 site.
Example migration PRs
You might want to refer to our migration PRs for Create React App and Flux as examples of how a migration for a basic Docusaurus v1 site can be done.