L’équipe open source de Meta a récemment publié Docusaurus 3.9, une mise à jour clé de son populaire générateur de sites statiques basé sur React.
Sa nouvelle version, annoncée le 25 septembre a introduit une nouvelle fonctionnalité importante : un assistant de recherche alimenté par l’IA.
Outre les nouvelles fonctionnalités, la mise à jour modernise également la technologie sous-jacente, obligeant les développeurs à utiliser Node.js 20 et mettant fin à la prise en charge de l’ancien Node.js 18.
Recherche conversationnelle alimentée par l’IA avec DocSearch v4
Pour les développeurs qui gèrent une documentation à grande échelle, l’ajout remarquable de Docusaurus 3.9 est la prise en charge complète de DocSearch v4 d’Algolia.
La mise à niveau introduit AskAI, une fonctionnalité qui transforme la barre de recherche standard d’un site en un assistant conversationnel.
Au lieu de simplement faire correspondre des mots-clés, l’outil fournit des réponses synthétisées, aidant les utilisateurs à résoudre les problèmes. plus efficacement.
Selon l’équipe Docusaurus, l’objectif est de « vous permettre d’ajouter à votre site Docusaurus un assistant de recherche alimenté par l’IA qui peut répondre aux questions basées sur le contenu de votre documentation avec une expérience conversationnelle. »
Le passage de la récupération de mots clés aux réponses conversationnelles marque une évolution majeure dans l’expérience utilisateur pour la documentation technique.
La mise en œuvre de cette recherche avancée est facultative, ce qui donne les équipes contrôlent la transition. Les responsables du projet peuvent choisir de rester sur DocSearch v3 ou de mettre à niveau progressivement pour débloquer les nouvelles capacités d’IA.
Pour ceux qui sont prêts à l’adopter, Algolia fournit un point d’entrée accessible. Sa page de tarification officielle détaille un niveau « Build » gratuit qui inclut 10 000 requêtes de recherche par mois, rendant la fonctionnalité viable pour les projets open source et les petites équipes.
Une telle intégration reflète une tendance plus large du secteur consistant à intégrer l’IA générative directement dans les plates-formes de développement pour augmenter la productivité et réduire friction des utilisateurs.
Modernisation de la base : Node.js 20 désormais requis
Dans le but d’améliorer la sécurité et les performances, Docusaurus 3.9 augmente son exigence de temps d’exécution minimum à Node.js v20.0, abandon officiel du support pour Node.js 18.
Étant donné que Node.js 18 a atteint sa fin de vie officielle, il ne reçoit plus de mises à jour de sécurité, ce qui fait de son utilisation continue une vulnérabilité potentielle.
L’équipe de Docusaurus considère cette mise à niveau obligatoire comme une étape cruciale pour maintenir une plate-forme sécurisée et stable.
« Abandon de la fin de vie Les versions de Node.js sur des versions mineures sont une pratique courante dans l’écosystème Node.js, que nous approuvons désormais officiellement et documentons dans notre processus de publication.”
Bien que cette décision soit une bonne pratique, elle nécessite une action de la part des équipes de développement. Son impact le plus immédiat concerne les pipelines CI/CD et les environnements de développement locaux.
Un exemple pratique de ceci est apparu sur GitHub, où un développeur a déposé un problème notant que les exemples de documentation officielle pour les actions GitHub indiquaient toujours que les actions GitHub étaient obsolètes. Node 18, nécessitant une mise à jour pour fonctionner correctement.
Les équipes devront auditer non seulement leurs scripts de build, mais également leurs Dockerfiles et leurs gestionnaires d’environnement locaux pour assurer une transition en douceur et éviter les échecs de build.
Flexibilité améliorée pour les sites de documentation mondiaux
Resolvant un défi de longue date pour les sites multilingues, Docusaurus 3.9 introduit des améliorations significatives. améliorations de l’internationalisation (i18n) système.
Les développeurs peuvent désormais remplacer les propriétés `baseUrl` et `url` pour chaque locale individuellement à l’aide du nouveau champ `i18n.localeConfigs[locale]`.
Il fournit le contrôle granulaire nécessaire pour les déploiements complexes et multi-domaines, par exemple l’hébergement de documents en anglais sur `docs.example.com` et de documents en français sur `docs.example.fr`, tout en garantissant que toutes les métadonnées et tous les liens sont résolus correctement.
D’autres optimisations d’i18n incluent un nouvel indicateur `translate`, qui est désormais désactivé par défaut pour les sites sans traduction, ce qui conduit à des temps de construction plus rapides en évitant les lectures inutiles du système de fichiers.
De plus, un nouvel attribut `key` peut être attribué aux éléments de la barre latérale. L’ajout de cette clé empêche Les clés de traduction sont en conflit lorsque plusieurs catégories partagent la même étiquette, telle que « API », garantissant que chaque instance peut être traduite de manière unique en fonction de son contexte dans la structure de la documentation.
Mises à niveau clés pour les diagrammes, les performances et l’expérience du développeur
Au-delà des fonctionnalités principales, Docusaurus 3.9 regroupe une foule d’autres améliorations précieuses.
Parmi celles-ci figure la prise en charge de l’algorithme de mise en page Mermaid ELK. Mermaid est un outil populaire pour créer des diagrammes à partir de texte, et son moteur de mise en page ELK offre des capacités de rendu plus sophistiquées, ce qui est particulièrement utile pour les diagrammes d’architecture système volumineux ou complexes.
Les performances sont également améliorées grâce à une mise à niveau vers Rspack 1.5, qui exploite de nouvelles options de configuration pour accélérer les temps de construction de Docusaurus. Des builds plus rapides se traduisent directement par une productivité plus élevée des développeurs, en particulier dans les grands projets.
D’autres changements notables incluent de nouveaux des crochets pour gérer les liens Markdown rompus, la possibilité de désactiver le rendu des emoji et une stabilité visuelle améliorée lors du basculement entre les modes de couleur.
Ces améliorations collectives solidifient la position de Docusaurus en tant que plate-forme robuste, performante et flexible pour la création de sites Web de documentation modernes.
