Metas åpen kildekode-team slapp nylig Docusaurus 3.9, en nøkkeloppdatering til den populære React-baserte statiske nettstedsgeneratoren.
Den nye versjonen, kunngjorde 25. september, -introduserte en betydelig ny AI-assistent.
I tillegg til nye funksjoner, moderniserer oppdateringen også den underliggende teknologien, og krever at utviklere bruker Node.js 20 og avslutter støtten for den eldre Node.js 18.
AI.>AI Samtalesøk med DocSearch v4
For utviklere som vedlikeholder dokumentasjon i stor skala, er det fremtredende tillegget i Docusaurus 3.9 full støtte for Algolias DocSearch v4.
Oppgraderingen introduserer AskAI, en funksjon som forvandler et nettsteds standardsøkefelt til en samtale-samsvarsassistent.
svar, og hjelper brukere med å løse problemer mer effektivt.
Ifølge Docusaurus-teamet er målet”å la deg legge til en AI-drevet søkeassistent på Docusaurus-nettstedet ditt som kan svare på spørsmål basert på hva som er i dokumentasjonen din med en samtaleopplevelse.”
Skifte fra søkeordhenting til samtalebaserte svardokumenter markerer en stor brukeropplevelsesdokumentasjon
.
Implementering av dette avanserte søket er opt-in, og gir team kontroll over overgangen. Prosjektvedlikeholdere kan velge å forbli på DocSearch v3 eller oppgradere trinnvis for å låse opp de nye AI-funksjonene.
For de som er klare til å ta i bruk det, gir Algolia et tilgjengelig inngangspunkt. Den offisielle prissiden beskriver et gratis «Build»-nivå som inkluderer 10 000 søkeforespørsler per måned, noe som gjør funksjonen levedyktig for åpen kildekode-prosjekter og mindre team.
En slik integrasjon gjenspeiler en bredere, generativ industriplattformtrend for å bygge direkte inn i AI-utviklingsplattformen. produktivitet og reduser brukerfriksjon.
Modernizing the Foundation: Node.js 20 Now Required
I et grep som tar sikte på å forbedre sikkerhet og ytelse, øker Docusaurus 3.9 minimumskravet til kjøretid til Node.js v20.0, offisielt droppe støtten for Node.js 18.
Fordi Node.js 18 har nådd sin offisielle levetid, mottar den ikke lenger sikkerhetsoppdateringer, noe som gjør dens fortsatte bruk til en potensiell sårbarhet.
Docusaurus sitt team rammer inn denne obligatoriske oppgraderingen som et viktig trinn for å opprettholde en sikker plattform for
og
. End-of-Life-versjoner av Node.js på mindre versjonsutgivelser er en vanlig praksis i Node.js-økosystemet, som vi nå offisielt støtter og dokumenterer på utgivelsesprosessen vår.”
Selv om denne beslutningen er en beste praksis, krever den handling fra utviklingsteam. Dens mest umiddelbare innvirkning er på CI/CD-rørledninger og lokale utviklingsmiljøer.
Et praktisk eksempel på dette dukket opp på GitHub, hvor en utvikler sendte inn et problem og merket at offisielle dokumentasjonseksempler fortsatt pekte på Git. utdatert Node 18, som krever en oppdatering for å fungere korrekt.
Team må revidere ikke bare byggeskriptene sine, men også Dockerfiles og lokale miljøansvarlige for å sikre en jevn overgang og unngå byggefeil.
Forbedret fleksibilitet for globale dokumentasjonssider
utfordringer med flere språk, adresser på flere språk. 3.9 introduserer betydelige forbedringer til internasjonalisering (i18n)-system.
Utviklere kan nå overstyre `baseUrl`-og `url`-egenskapene for hver lokalitet individuelt ved å bruke det nye `i18n.localeConfigs[locale]`-feltet.
Det gir den granulære kontrollen som trengs for komplekse, multi-domener – engelske doc-distribusjoner for eksempel. på `docs.example.com` og French docs at `docs.example.fr`, samtidig som man sikrer at alle metadata og lenker løses riktig.
Ytterligere i18n-optimaliseringer inkluderer et nytt `translate`-flagg, som nå er deaktivert som standard for nettsteder uten oversettelser, noe som fører til raskere byggetider ved å unngå å lese unødvendige filsystemer,
.”nøkkel”-attributt kan være tilordnet sidefeltelementer. Ved å legge til denne nøkkelen forhindres oversettelsesnøkkelkonflikter når flere kategorier deler samme etikett, for eksempel «API», og sikrer at hver forekomst kan oversettes unikt basert på konteksten innenfor dokumentasjonsstrukturen.
Nøkkeloppgraderinger for diagrammer, ytelse og utvikleropplevelse
Beyond the headline-funksjoner 3. forbedringer.
Blant disse er støtte for Mermaid ELK-layoutalgoritmen. Mermaid er et populært verktøy for å lage diagrammer fra tekst, og ELK-layoutmotoren gir mer sofistikerte gjengivelsesmuligheter, som er spesielt nyttige. store eller intrikate systemarkitekturdiagrammer.
Ytelsen får også et løft med en oppgradering til Rspack 1.5, som utnytter nye konfigurasjonsalternativer for å akselerere Docusaurus-byggetiden. Spesielt raskere bygg gir høyere utviklerproduktivitet i store prosjekter.
Andre bemerkelsesverdige endringer inkluderer nye kroker for håndtering av ødelagte Markdown-lenker, muligheten til å deaktivere emoji-gjengivelse og forbedret visuell stabilitet når du bytter mellom fargemoduser.
Disse kollektive forbedringene befester Docusaurus sin posisjon som en robust, ytende og fleksibel plattform for å bygge moderne dokumentasjonsnettsteder.
