Visão geral da migração

Este documento o orienta na migração de um site existente do Docusaurus 1 para o Docusaurus 2.

We try to make this as easy as possible, and provide a migration CLI.

Principais diferenças

Docusaurus 1 é um gerador de site de documentação puro, usando React como um mecanismo de template do lado do servidor, mas não carregando o React no navegador.

O Docusaurus 2, reconstruído do zero, gera um aplicativo de página única, usando todo o poder do React no navegador. Ele permite mais personalização, mas preserva as melhores partes do Docusaurus 1 - fácil de começar, documentos com versão e i18n.

Além disso, o Docusaurus 2 é um gerador de sites estáticos de alto desempenho e pode ser usado para criar sites baseados em conteúdo comuns (por exemplo, documentação, blogs, landing de produtos páginas de marketing, etc.) extremamente rapidamente.

Embora nosso foco principal ainda seja ajudá-lo a obter suas documentações corretamente, é possível construir qualquer tipo de site usando o Docusaurus 2, pois é apenas um aplicativo React. Docusaurus agora pode ser usado para construir qualquer site, não apenas sites de documentação.

Estrutura do Docusaurus 1

Seu site Docusaurus 1 deve ter a seguinte estrutura:

├── docs
└── website
    ├── blog
    ├── core
    │   └── Footer.js
    ├── package.json
    ├── pages
    ├── sidebars.json
    ├── siteConfig.js
    └── static

Estrutura do Docusaurus 2

Após a migração, seu site Docusaurus 2 pode se parecer:

├── docs
└── website
    ├── blog
    ├── src
    │   ├── components
    │   ├── css
    │   └── pages
    ├── static
    ├── package.json
    ├── sidebars.json
    ├── docusaurus.config.js

info

Esta migração não altera o local da pasta /docs, mas os sites Docusaurus v2 geralmente têm a pasta /docs dentro de /website

Você está livre para colocar a pasta /docs em qualquer lugar que desejar após ter migrado para a v2.

Processo de migração

Existem várias coisas a migrar para obter um site do Docusaurus 2 totalmente funcional:

• packages
• Comandos CLI
• configuração do site
• Arquivos Markdown
• arquivo sidebars
• páginas, componentes e CSS
• documentos versionados
• i18n suporte 🚧

Processo de migração automatizado

The migration CLI will handle many things of the migration for you.

No entanto, algumas peças não podem ser automatizadas facilmente e você terá que voltar para o processo manual.

note

We recommend running the migration CLI, and complete the missing parts thanks to the manual migration process.

Processo de migração manual

Algumas partes da migração não podem ser automatizadas (principalmente as páginas) e você terá que migrá-las manualmente.

The manual migration guide will give you all the manual steps.

Suporte

For any questions, you can ask in the #migration-v1-to-v2 Discord channel.

Sinta-se à vontade para marcar @slorber em qualquer PRs de migração se quiser que a gente dê uma olhada.

Também temos voluntários dispostos a ajudá-lo a migrar seu site v1.

Exemplo de PRs de migração

Você pode consultar nossos PRs de migração para Criar aplicativo React e Flux como exemplos de como uma migração para um site Docusaurus v1 básico pode ser feita.