Aller au contenu principal
Version: 2.0.0-alpha.73

Vue d'ensemble de la migration

Ce document vous guide à travers la migration d'un site Docusaurus 1 existant vers Docusaurus 2.

Nous essayons de rendre cela aussi facile que possible, et fournissons un CLI de migration.

Structure Docusaurus 1#

Votre site Docusaurus 1 devrait avoir la structure suivante :

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

Structure Docusaurus 2#

Après la migration, votre site Docusaurus 2 pourrait ressembler à :

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

Cette migration ne change pas l'emplacement du dossier /docs, mais les sites Docusaurus v2 ont généralement le dossier /docs à l'intérieur de /website

Vous êtes libre de mettre le dossier /docs où vous voulez après avoir migré en v2.

Processus de migration#

Il y a plusieurs choses à migrer pour obtenir un site web Docusaurus 2 entièrement fonctionnel :

  • paquets
  • commandes du cli
  • configuration du site
  • fichiers Markdown
  • fichier sidebars (barres latérales)
  • pages, composants et CSS
  • docs versionnées
  • support i18n 🚧

Processus de migration automatisé#

Le cli de migration se chargera pour vous de nombreuses choses de la migration.

Cependant, certaines parties ne peuvent pas être facilement automatisées, et vous devrez revenir au processus manuel.

remarque

Nous vous recommandons d'exécuter le cli, et de compléter les pièces manquantes grâce au processus de migration manuelle.

Processus de migration manuel#

Certaines parties de la migration ne peuvent pas être automatisées (en particulier les pages), et vous devrez les migrer manuellement.

Le guide de migration manuel vous donnera toutes les étapes manuelles.

Support#

Pour toute question, vous pouvez les poser dans le canal #docusaurus-1-to-2-migration de Discord.

N'hésitez pas à mentionner @slorber dans vos PR de migration si vous souhaitez que nous y jetions un œil.

Nous avons également des bénévoles prêts à vous aider à migrer votre site v1.

Exemple de PR de migration#

Vous pouvez vous référer à nos PR de migration pour Create React App et Flux de la façon dont une migration pour un site Docusaurus v1 de base peut être effectuée.