Das Open-Source-Team von Meta hat kürzlich Docusaurus 3.9 veröffentlicht, ein wichtiges Update seines beliebten React-basierten statischen Site-Generators.
Die neue Version, am 25. September angekündigt, führte eine bedeutende neue Funktion ein: einen KI-gestützten Suchassistenten.
Neben neuen Funktionen modernisiert das Update auch die zugrunde liegende Technologie, sodass Entwickler Node.js 20 verwenden müssen und die Unterstützung für das ältere Node.js 18 eingestellt wird.
KI-gestützte Konversationssuche mit DocSearch v4
Für Entwickler, die umfangreiche Dokumentationen verwalten, ist die herausragende Neuerung in Docusaurus 3.9 die vollständige Unterstützung von DocSearch v4 von Algolia.
Das Upgrade führt AskAI ein, eine Funktion, die die Standardsuchleiste einer Website in einen Konversationsassistenten verwandelt.
Anstatt nur passende Schlüsselwörter bereitzustellen, bietet das Tool synthetisierte Antworten und hilft Benutzern bei der Lösung von Problemen effizienter.
Laut dem Docusaurus-Team besteht das Ziel darin, „Ihrer Docusaurus-Website einen KI-gestützten Suchassistenten hinzuzufügen, der Fragen basierend auf dem Inhalt Ihrer Dokumentation mit einem Konversationserlebnis beantworten kann.“
Die Umstellung von der Schlüsselwortsuche auf Konversationsantworten stellt eine wesentliche Weiterentwicklung des Benutzererlebnisses für technische Dokumentation dar.
Die Implementierung dieser erweiterten Suche erfolgt mit Opt-in Teams kontrollieren den Übergang. Projektbetreuer können wählen, ob sie bei DocSearch v3 bleiben oder schrittweise ein Upgrade durchführen möchten, um die neuen KI-Funktionen freizuschalten.
Für diejenigen, die bereit sind, es einzuführen, bietet Algolia einen zugänglichen Einstiegspunkt. Auf der offiziellen Preisseite ist eine kostenlose „Build“-Stufe aufgeführt, die 10.000 Suchanfragen pro Monat umfasst, wodurch die Funktion für Open-Source-Projekte und kleinere Teams nutzbar wird.
Eine solche Integration spiegelt einen breiteren Branchentrend wider, generative KI direkt in Entwicklerplattformen einzubetten, um die Produktivität zu steigern und Reduzieren Sie die Benutzerreibung.
Modernisierung der Grundlage: Node.js 20 jetzt erforderlich
Um die Sicherheit und Leistung zu verbessern, erhöht Docusaurus 3.9 seine Mindestlaufzeitanforderung auf Node.js v20.0, Offizielle Einstellung der Unterstützung für Node.js 18.
Da Node.js 18 sein offizielles Lebensende erreicht hat, erhält es keine Sicherheitsupdates mehr, was seine weitere Verwendung zu einer potenziellen Schwachstelle macht.
Das Team von Docusaurus betrachtet dieses obligatorische Upgrade als einen entscheidenden Schritt für die Aufrechterhaltung einer sicheren und stabilen Plattform.
„Ende der Lebensdauer einstellen.“ Versionen von Node.js auf Nebenversionsveröffentlichungen sind eine gängige Praxis im Node.js-Ökosystem, die wir jetzt offiziell befürworten und in unserem Veröffentlichungsprozess dokumentieren.“
Obwohl diese Entscheidung eine bewährte Vorgehensweise ist, erfordert sie Maßnahmen von Entwicklungsteams. Die unmittelbarsten Auswirkungen betreffen CI/CD-Pipelines und lokale Entwicklungsumgebungen.
Ein praktisches Beispiel hierfür erschien auf GitHub, wo ein Entwickler ein Problem einreichte und feststellte, dass offizielle Dokumentationsbeispiele für GitHub-Aktionen immer noch auf den veralteten Node verwiesen 18 und erfordert ein Update, um ordnungsgemäß zu funktionieren.
Teams müssen nicht nur ihre Build-Skripte, sondern auch ihre Docker-Dateien und lokalen Umgebungsmanager prüfen, um einen reibungslosen Übergang sicherzustellen und Build-Fehler zu vermeiden.
Erhöhte Flexibilität für globale Dokumentationsseiten
Docusaurus 3.9 geht eine seit langem bestehende Herausforderung für mehrsprachige Websites an und führt erhebliche Verbesserungen ein Internationalisierung (i18n) System.
Entwickler können jetzt die Eigenschaften „baseUrl“ und „url“ für jedes Gebietsschema einzeln überschreiben, indem sie das neue Feld „i18n.localeConfigs[locale]“ verwenden.
Es bietet die detaillierte Kontrolle, die für komplexe Bereitstellungen mit mehreren Domänen erforderlich ist – zum Beispiel das Hosten englischer Dokumente unter „docs.example.com“ und französischer Dokumente unter `docs.example.fr`, während sichergestellt wird, dass alle Metadaten und Links korrekt aufgelöst werden.
Zu den weiteren i18n-Optimierungen gehört ein neues `translate`-Flag, das jetzt standardmäßig für Websites ohne Übersetzungen deaktiviert ist, was zu schnelleren Erstellungszeiten führt, indem unnötige Dateisystem-Lesevorgänge vermieden werden.
Zusätzlich kann Seitenleistenelementen ein neues `key`-Attribut zugewiesen werden. Das Hinzufügen dieses Schlüssels verhindert die Übersetzung Schlüsselkonflikte, wenn mehrere Kategorien die gleiche Bezeichnung wie „API“ haben, stellen sicher, dass jede Instanz basierend auf ihrem Kontext innerhalb der Dokumentationsstruktur eindeutig übersetzt werden kann.
Wichtige Upgrades für Diagramme, Leistung und Entwicklererfahrung
Über die Hauptfunktionen hinaus bündelt Docusaurus 3.9 eine Vielzahl weiterer wertvoller Verbesserungen.
Dazu gehört die Unterstützung für der Mermaid ELK-Layout-Algorithmus. Mermaid ist ein beliebtes Tool zum Erstellen von Diagrammen aus Text, und seine ELK-Layout-Engine bietet ausgefeiltere Rendering-Funktionen, was besonders nützlich für große oder komplexe Systemarchitekturdiagramme ist.
Die Leistung wird auch durch ein Upgrade aufRspack 1.5 gesteigert, das neue Konfigurationsoptionen nutzt, um die Erstellungszeiten von Docusaurus zu beschleunigen. Schnellere Builds führen direkt zu einer höheren Entwicklerproduktivität, insbesondere bei großen Projekten.
Weitere bemerkenswerte Änderungen Dazu gehören neue Hooks für den Umgang mit defekten Markdown-Links, die Möglichkeit, das Emoji-Rendering zu deaktivieren und eine verbesserte visuelle Stabilität beim Wechsel zwischen Farbmodi.
Diese kollektiven Verbesserungen festigen die Position von Docusaurus als robuste, leistungsstarke und flexible Plattform für die Erstellung moderner Dokumentationswebsites.
