Aller au contenu principal

Récapitulatif de Docusaurus 2019

· 4 minutes de lecture
Yangshun Tay

2019 a été une excellente année pour Docusaurus - nous avons fait d'énormes progrès sur Docusaurus 2. Les utilisateurs actuels de Docusaurus 1 qui n'utilisent pas la fonctionnalité de traduction peuvent librement le vérifier et migrer vers cette version ! Sinon, nous travaillerons avec vous pour que cela se produise en 2020 :)

Docusaurus 2 (D2)

En 2018, nous avons proposé de reconstruire Docusaurus à partir de zéro. Il s'agissait d'un effort majeur de restructuration - nous avons créé de toutes pièces un framework CSS centré sur le contenu, un système de plugins, et nous sommes passés de pages HTML statiques à une application à page unique avec des routes pré-rendues. Il s'agissait d'une folle aventure et d'un exploit difficile, en particulier sans aucun ETP dédié au projet. Avec l'aide de @endilie, notre ex-stagiaire devenu contributeur puis mainteneur, nous avons vraiment bien avancé sur D2 et nous en sommes actuellement à la version 2.0.0-alpha.40. Toutes les fonctionnalités de Docusaurus 1 à l'exception des traductions ont été portées.

Les fonctionnalités phares de D2 sont le mode sombre et ses superbes performances. D2 a la prise en charge du mode sombre et il est presque facile de créer un site de documentation sombre et convivial. Endilie a fait de gros efforts pour optimiser les performances du site et un grand nombre d'astuces d'optimisation des performances ont été réalisées par défaut : images optimisées, prérendu de chaque route en HTML statique et routage côté client par la suite, préchargement des ressources nécessaires aux futures navigations lorsque l'utilisateur survole un lien de navigation, etc.

Enfin, nous avons mis en place une architecture de plugins et transformé le repo en un monorepo Lerna. Nous pensons que cette architecture de plugins contribuera à la création d'une communauté et permettra aux utilisateurs de créer leurs propres fonctionnalités pour leurs cas d'utilisation particuliers.

Activité GitHub

  • Stars : 10050 -> 14632 (+45.6% sur une année glissante)
  • Total des contributeurs : 182 -> 303 (+66,4% sur une année glissante). Dont la plupart sont des contributeurs non-Facebook
  • Téléchargements journaliers npm : 728 -> 2320 (+218.7% sur une année glissante). Le pic était en novembre
  • D1 est actuellement utilisé par 3872 projets sur GitHub alors que D2 est utilisé par 247 projets sur GitHub
  • Nous avons maintenant 4 contributeurs actifs ! (+100% sur une année glissante)

Utilisateurs notables

Une bonne partie des projets au sein de la communauté Open Source utilisent Docusaurus. Ce semestre, nous avons également intégré des projets plus importants dans Docusaurus 2 :

Et accueilli plus de projets sur Docusaurus 1 :

Médias

Yangshun a donné une session de formation pendant le F8 sur Utiliser Docusaurus pour créer des sites web open source.

Communauté

Quelques services d'hébergement/développement tiers ont également une intégration de première classe avec une installation de Docusaurus :

Perspectives d'avenir

D2 a gagné une certaine popularité parmi la communauté des développeurs. En 2020, nous voulons atteindre la parité totale des fonctionnalités avec D1 dès le premier semestre et aider les projets Facebook restants sur D1 à passer sur D2. Ce serait également une bonne chose si nous pouvions utiliser Docusaurus pour la documentation interne, mais c'est une entreprise non triviale. Si vous en avez besoin ou si vous avez des idées, venez nous en parler !

Un grand merci à la communauté pour ses contributions, en particulier à l'équipe centrale - Endilie Yacop Sucipto, Alexey Pyltsyn, Wei Gao. Enfin, merci Joel Marcey d'avoir démarré Docusaurus et soutenu le projet tout ce temps.

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