Zespół Meta firmy Open Source wydał niedawno Docusaurus 3.9, kluczową aktualizację popularnego generatora stron statycznych opartego na React.
Jego nowa wersja, ogłoszona 25 września wprowadziła nową, znaczącą funkcję: asystenta wyszukiwania opartego na sztucznej inteligencji.
Oprócz nowych funkcji aktualizacja modernizuje także podstawową technologię, wymagając od programistów korzystania z Node.js 20 i kończąc obsługę starszej wersji Node.js 18.
Wyszukiwanie konwersacyjne oparte na sztucznej inteligencji DocSearch v4
Dla programistów zajmujących się dokumentacją na dużą skalę wyjątkowym dodatkiem w Docusaurus 3.9 jest pełna obsługa DocSearch v4 Algolii.
Aktualizacja wprowadza AskAI, funkcję, która przekształca standardowy pasek wyszukiwania witryny w asystenta konwersacyjnego.
Zamiast dopasowywać słowa kluczowe, narzędzie zapewnia syntetyczne odpowiedzi, pomagając użytkownikom efektywniej rozwiązywać problemy.
Według zespołu Docusaurus celem jest „umożliwienie dodania do witryny Docusaurus asystenta wyszukiwania opartego na sztucznej inteligencji, który będzie w stanie odpowiadać na pytania w oparciu o dokumentację za pomocą konwersacji.”
Przejście od wyszukiwania słów kluczowych do odpowiedzi konwersacyjnych oznacza poważną ewolucję w zakresie wygody użytkownika związanej z dokumentacją techniczną.
Wdrożenie tego zaawansowanego wyszukiwania polega na tym, że opt-in, dając zespołom kontrolę nad przejściem. Opiekunowie projektu mogą zdecydować się na pozostanie przy DocSearch v3 lub stopniową aktualizację, aby odblokować nowe możliwości sztucznej inteligencji.
Dla tych, którzy są gotowi na jego przyjęcie, Algolia zapewnia dostępny punkt wejścia. Oficjalna strona z cenami zawiera szczegółowy opis bezpłatnego poziomu „Kompiluj”, który obejmuje 10 000 żądań wyszukiwania miesięcznie, dzięki czemu funkcja ta jest przydatna w przypadku projektów open source i mniejszych zespołów.
Taka integracja odzwierciedla szerszy trend branżowy polegający na osadzaniu generatywnej sztucznej inteligencji bezpośrednio na platformach programistów w celu zwiększenia produktywności i zmniejsz problemy użytkowników.
Modernizacja podstawy: teraz wymagany Node.js 20
W posunięciu mającym na celu poprawę bezpieczeństwa i wydajności Docusaurus 3.9 podnosi minimalne wymagania dotyczące czasu działania do Node.js v20.0, oficjalnie rezygnujemy ze wsparcia dla Node.js 18.
Ponieważ Node.js 18 dobiegł oficjalnego końca, nie otrzymuje już aktualizacji zabezpieczeń, co sprawia, że dalsze korzystanie z niego stanowi potencjalną lukę w zabezpieczeniach.
Zespół Docusaurus uważa tę obowiązkową aktualizację za kluczowy krok w utrzymaniu bezpiecznej i stabilnej platformy.
„Porzucenie wycofania z eksploatacji wersje Node.js w mniejszych wersjach to powszechna praktyka w ekosystemie Node.js, którą teraz oficjalnie popieramy i dokumentujemy w naszym procesie wydawania.”
Chociaż ta decyzja jest najlepszą praktyką, wymaga działania ze strony zespołów programistycznych. Najbardziej bezpośredni wpływ ma na potoki CI/CD i lokalne środowiska programistyczne.
Praktyczny przykład tego pojawił się w GitHub, gdzie programista zgłosił problem, zauważając, że oficjalne przykłady dokumentacji dla GitHub Actions nadal wskazywały na przestarzałe Węzeł 18, wymagający aktualizacji do prawidłowego działania.
Zespoły będą musiały sprawdzić nie tylko swoje skrypty kompilacji, ale także pliki Dockerfile i lokalnych menedżerów środowiska, aby zapewnić płynne przejście i uniknąć błędów kompilacji.
Większa elastyczność globalnych witryn dokumentacji
Odpowiadając na długotrwałe wyzwanie dla witryn wielojęzycznych, Docusaurus 3.9 wprowadza istotne zmiany ulepszenia internacjonalizacja (i18n) system.
Programiści mogą teraz zmieniać właściwości `baseUrl` i `url` dla każdego ustawienia regionalnego indywidualnie, korzystając z nowego pola `i18n.localeConfigs[locale]`.
Zapewnia szczegółową kontrolę potrzebną w przypadku złożonych wdrożeń obejmujących wiele domen — na przykład hosting dokumentów w języku angielskim pod adresem `docs.example.com` i dokumentów francuskich pod adresem `docs.example.fr`, zapewniając jednocześnie prawidłowe rozwiązywanie wszystkich metadanych i łączy.
Dalsze optymalizacje i18n obejmują nową flagę `tłumacz`, która jest teraz domyślnie wyłączona dla witryn bez tłumaczeń, co skraca czas kompilacji poprzez uniknięcie niepotrzebnych odczytów systemu plików.
Dodatkowo nowy atrybut `key` można przypisać do elementów paska bocznego. Dodanie tego klucza zapobiega konfliktom kluczy tłumaczeniowych, gdy wiele kategorii ma tę samą etykietę, np. „API”, zapewniając, że każde wystąpienie może zostać przetłumaczone w sposób unikalny na podstawie kontekstu w strukturze dokumentacji.
Kluczowe ulepszenia w zakresie diagramów, wydajności i komfortu programisty
Oprócz głównych funkcji, Docusaurus 3.9 zawiera wiele innych cennych ulepszeń.
Wśród nich znajduje się obsługa algorytmu układu Mermaid ELK. Mermaid to popularne narzędzie do tworzenia diagramów z tekstu, a jego silnik układu ELK zapewnia bardziej zaawansowane możliwości renderowania, co jest szczególnie przydatne w przypadku dużej lub skomplikowanej architektury systemów diagramy.
Wydajność również wzrasta dzięki aktualizacji do Rspack 1.5, który wykorzystuje nowe opcje konfiguracji w celu skrócenia czasu tworzenia Docusaurus. Szybsze kompilacje przekładają się bezpośrednio na wyższą produktywność programistów, szczególnie w przypadku dużych projektów projekty.
Inne godne uwagi zmiany obejmują nowe zaczepy do obsługi uszkodzonych linków Markdown, możliwość wyłączenia renderowania emoji i poprawioną stabilność wizualną podczas przełączania między trybami kolorów.
Te zbiorcze udoskonalenia umacniają pozycję Docusaurus jako solidnej, wydajnej i elastycznej platformy do tworzenia nowoczesnych witryn z dokumentacją.
