Visão Geral

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.

Beyond that, Docusaurus 2 is a performant static site generator and can be used to create common content-driven websites (e.g. Documentation, Blogs, Product Landing and Marketing Pages, etc) extremely quickly.

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 can now be used to build any website, not just documentation websites.

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

This migration does not change the /docs folder location, but Docusaurus v2 sites generally have the /docs folder inside /website

You are free to put the /docs folder anywhere you want after having migrated to 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.

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.

Exemplo de PRs de migração

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.