Aller au contenu principal

Récapitulatif de Docusaurus 2020

· 6 minutes de lecture
Sébastien Lorber

2020 a été formidable pour Docusaurus, malgré un départ regrettable et une année tumultueuse pour tout le monde.

Nous avons continué à investir dans Docusaurus 2 et l'avons fait atteindre la parité des fonctionnalités avec Docusaurus 1.

Nous recommandons maintenant Docusaurus 2 comme choix par défaut pour démarrer un nouveau projet Docusaurus et nous encourageons les utilisateurs v1 à migrer vers Docusaurus 2.

Nous sommes toujours en alpha, mais attendez-vous à de bonnes nouvelles très bientôt !

Docusaurus v1 vs v2 tendances de npm

Points forts de Docusaurus 2

Nous avons travaillé sur de nombreuses fonctionnalités cette année et nous voudrions en souligner les plus importantes :

  • i18n : traduisez facilement votre site Docusaurus, disponible prochainement ! (aperçu, doc)
  • Liste déroulante de version : active le commutateur contextuel de version
  • Options de gestion de version : résolution des problèmes les plus courants rencontrés par les utilisateurs en matière de version
  • Recherche contextuelle : recherche dans la version actuelle, utilisez la toute nouvelle expérience DocSearch 3
  • Pages Markdown : utilisez Markdown au lieu de composants React pour créer des pages autonomes
  • Meilleur thème : diverses améliorations de l'interface, de l'UX et de l'accessibilité
  • PWA : ajoute la prise en charge hors ligne à votre site et le rend installable
  • Fail-fast : validation stricte de la configuration, détection des liens erronés et prévention des mauvais déploiements en production
  • Multi-instance : utilisez le plugin docs deux fois sur un seul site (exemple : docs iOS/Android SDK)
  • CLI de migration : automatiser la montée de version depuis Docusaurus 1
  • CodeSandbox : évaluer Docusaurus facilement depuis votre navigateur avec new.docusaurus.io
  • Versions canary : utilisez la balise @canary avec npm pour utiliser la prochaine version avant tout le monde
  • TypeScript : adoption progressive pour le code interne, et amélioration de l'utilisation pour les utilisateurs
  • Publier Infima : c'est maintenant open-source

Croissance de Docusaurus 2

Le projet de reconstruire Docusaurus à partir de zéro en 2019 a porté ses fruits : après un démarrage lent, Docusaurus 2 a été largement adopté et a déjà dépassé l'utilisation de Docusaurus 1.

Docusaurus v1 vs v2 tendances de npm

Des projets notables, startups, grandes entreprises et individus ont adopté Docusaurus 2 (galerie) :

Nous avons aidé des sites Docusaurus 1 de grande envergure pour se mettre à niveau, en assurant un chemin de migration approprié et une parité des fonctionnalités.

React Native a été mis à jour avec succès vers Docusaurus 2 (site archivé v1 ) :

Capture d'écran React Native

Les sites localisés de Docusaurus 1 (comme Jest) pourront également être mis à jour :

Capture d'écran Jest en japonais

Nous avons également vu la publication du premier site de droite à gauche Docusaurus 2 :

Datagit screenshot

Activité GitHub

  • Stars : 14632 -> 20946 (+43.2% sur une année glissante)
  • Contributeurs totaux : 303 -> 512 (+68.9% sur une année glissante). Dont la plupart sont des contributeurs non-Facebook
  • Téléchargements hebdomadaires npm : 2356 -> 25592 (+986% sur une année glissante)
  • Sur GitHub, Docusaurus 1 est utilisé par 6311 projets (+62,9% sur une année glissante) alors que Docusaurus 2 est utilisé par 5039 projets (+1940% sur une année glissante)

Collaboration avec Major League Hacking

Nous avons déjà accueilli les camarades de Major League Hacking (MLH) pendant 2 saisons.

Nous sommes très reconnaissants pour les contributions diverses qu'ils ont apportées, telles que :

  • Rédaction des fondations de la CLI de migration de v1 vers v2
  • Aide pour migrer le site web React Native de la v1 vers la v2
  • Rendre la validation de la configuration plus stricte et exhaustive, renvoyant des messages d'erreur utiles
  • Ajout du support CodeSandbox
  • Amélioration des pipelines de CI : taille de construction et bots Lighthouse

Nous sommes impatients de poursuivre cette collaboration en 2021.

Médias

Dmitry Vinnik (Developer Advocate @ Facebook) explique Docusaurus en 60 secondes ou 15 minutes de vidéos.

Rachel Nabors (Ingénieur de documentation @ Facebook) a parlé un peu de Docusaurus dans React Native Radio 178 (podcast), et William Candillon la migration du site web React Native (vidéo).

De nombreux articles de blog ont été publiés :

Communauté

La communauté Docusaurus continue de grandir, le serveur Discord est très actif et les questions Stack Overflow continuent d'être postées.

L'architecture modulaire de Docusaurus 2 a permis à la communauté de construire et de publier des plugins tiers. Comme nous souhaitons mieux fédérer notre communauté, si vous construisez un plugin, veuillez nous le faire savoir.

Et ensuite ?

Comme les fonctionnalités de base de Docusaurus 2 sont enfin construites, nous pourrons consacrer plus de temps à la résolution des problèmes et des bogues signalés par la communauté, et faire en sorte que Docusaurus soit suffisamment stable et pratique pour passer à la phase bêta et à la phase de validation (release-candidate).

Avec une prise en charge adéquate de l'i18n et de la gestion de version, et des migrations à grande échelle telles que React Native et Jest, nous disposons désormais d'une voie de migration claire pour tous les sites de Docusaurus 1.

Nous avons encore quelques fonctionnalités majeures sur lesquelles nous aimerions travailler :

Un grand merci à la communauté pour leurs contributions en 2020, en particulier :

  • Joel Marcey pour la création de Docusaurus et le soutien du projet tout ce temps
  • l'équipe centrale - Alexey Pyltsyn, Sébastien Lorber, Yangshun Tay
  • les stagiaires de Major League Hacking et de Facebook pour leur impact significatif
  • l'équipe d'Algolia pour DocSearch 3 et leur soutien
  • Bartosz Kaszubowski pour son investissement dans la migration React Native
  • toute la communauté pour leurs contributions et leur soutien mutuel

À la santé d'une bonne année 2021 ! 🎉