Migração automatizada

A CLI de migração migra automaticamente seu site v1 para um site v2.

info

O trabalho manual ainda é necessário após usar a CLI de migração, pois não podemos automatizar uma migração completa

A CLI de migração migra:

• Configurações do site (de siteConfig.js para docusaurus.config.js)
• package.json
• sidebars.json
• /docs
• /blog
• /static
• versioned_sidebar.json e /versioned_docs se o seu site usa versionamento

Para usar a CLI de migração, siga estas etapas:

1. Antes de usar a CLI de migração, certifique-se de que /docs, /blog, /static, sidebars.json, siteConfig.js, package.json seguem a estrutura mostrada no início desta página.

2. Para migrar seu site v1, execute a CLI de migração com os caminhos apropriados do sistema de arquivos:

# formato de comando de migração
npx @docusaurus/migrate migrate <v1 website directory> <desired v2 website directory>

# exemplo
npx @docusaurus/migrate migrate ./v1-website ./v2-website

3. Para visualizar seu novo site localmente, vá para o diretório do site v2 e inicie o servidor de desenvolvimento.

cd ./v2-website
yarn install
yarn start

danger

A migração CLI atualiza os arquivos existentes. Certifique-se de ter feito commit deles primeiro!

Opções

Você pode adicionar sinalizadores de opção à CLI de migração para migrar automaticamente o conteúdo e as páginas do Markdown para a v2. É provável que você ainda precise fazer algumas alterações manuais para obter o resultado desejado.

Nome	Descrição
--mdx	Adicionar flag para converter Markdown em MDX automaticamente
--page	Adicionar flag para migrar páginas automaticamente

# exemplo usando opções
npx @docusaurus/migrate migrate --mdx --page ./v1-website ./v2-website

danger

A migração de páginas e MDX ainda é um trabalho em andamento.

Recomendamos que você tente executar as páginas sem essas opções, confirme e tente executar a migração novamente com as opções --page e --mdx.

Dessa forma, você poderá inspecionar e corrigir facilmente o diff.